https://github.com/2wce/react-barcode-scanner-ts
https://github.com/2wce/react-barcode-scanner-ts
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/2wce/react-barcode-scanner-ts
- Owner: 2wce
- Created: 2021-07-22T09:36:27.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-22T19:28:38.000Z (over 3 years ago)
- Last Synced: 2025-02-01T12:12:08.807Z (over 1 year ago)
- Language: JavaScript
- Size: 342 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript NPM Package
Scaffold TypeScript npm packages using this template to bootstrap your next library.
This project includes:
- [TypeScript](https://www.typescriptlang.org/)
- [Rollup](https://rollupjs.org/)
- [Microsoft API Extractor](https://api-extractor.com/)
- [TypeDoc](https://typedoc.org/)
## Getting Started
Begin via any of the following:
- Press the "*Use this template*" button
- Use [degit](https://github.com/Rich-Harris/degit) to execute:
```
degit github:jasonsturges/typescript-npm-package
```
- Use [GitHub CLI](https://cli.github.com/) to execute:
```
gh repo create --template="https://github.com/jasonsturges/typescript-npm-package"
```
- Simply `git clone`, delete the existing .git folder, and then:
```
git init
git add -A
git commit -m "Initial commit"
````
Remember to use `npm search ` to avoid naming conflicts in the NPM Registery for your new package name.
## Usage
The following tasks are available for `npm run`:
- `dev`: Run Rollup in watch mode to detect changes to files during development
- `build`: Run Rollup to build a production release distributable
- `build:types`: Run Microsoft API Extractor to rollup a types declaration (`d.ts`) file
- `docs`: Run TypeDoc for TSDoc generated documentation in the "*docs/*" folder
- `clean`: Remove all build artifacts
## Development
While test driven development (TDD) would be a good approach to develop your library, also consider creating an app for prototyping and local testing of your library.
**From your library project**, issue the `npm link` command:
```
npm link
```
Start Rollup in watch mode:
```
npm run dev
```
**Create a test app project**, by doing the following:
To use your npm package library locally for development, create a new project in a separate folder:
```
mkdir test-app && cd test-app
npm init
```
Take the defaults from `npm init`; then, add TypeScript:
```
npm install typescript --save-dev
```
In the package.json of your test app, add the following two things:
- Set the `type` of your package to `module`
- Add a `start` script to execute your app
```json
"type": "module",
"scripts": {
"start": "tsc && node index.js",
},
```
Link to your library using the `npm link ` command - be sure the `` matches your library's package.json name. For example:
```
npm link typescript-npm-package
```
Add a "*tsconfig.json*" file to your test app that includes a `baseUrl` and references the `paths` to your npm linked module. Again, be sure the `paths` name matches your library's package.json name. For example:
```json
{
"compilerOptions": {
"target": "es6",
"module": "esnext",
"moduleResolution": "node",
"strict": true,
"esModuleInterop": true,
"baseUrl": ".",
"paths": {
"typescript-npm-package": ["node_modules/typescript-npm-package/src"],
"typescript-npm-package/*": ["node_modules/typescript-npm-package/src/*"]
}
}
}
```
Now, run your app via `npm start`.
As an example, if your library's "*index.ts*" file contained:
```ts
export const sayHi = () => {
console.log("Hi");
};
```
...your test app would implement an import using your package name, such as:
```ts
import { sayHi } from "typescript-npm-package";
sayHi();
```