v-basarat-ali-react-ts-module

npm init Create package.json

Usage no npm install needed!

<script type="module">
  import vBasaratAliReactTsModule from 'https://cdn.skypack.dev/v-basarat-ali-react-ts-module';
</script>

README

npm React module

Version: Basarat Ali

Process of creation

1. typescript npm module

  1. npm init Create package.json

  2. npm i -D typescript Install compiler

  3. npx tsc --init Initialize tsconfig.json.

  • Target es5
  • module commonjs
  • strict true
  • esModuleInterop true
  • declaration: true
  • declarationMap: true
  • sourceMap: true
  • outDir: lib
  • add include in src

  1. touch src/index.ts and add export some function

  2. tweak package.json

  • Ensure unique package name
  • main should point to "lib/index.js"
  • add types pointing to lib
  • add build script tsc -p . where the flag points to the project to compile

2. Enhance adding React

  1. npm i react @types/react -D In package.json add peerDependencies indicating that the project using this library should use a react with version at least 16.0.0

  2. Enable jsx to react in tsconfig.json

  3. mv src/index.ts src/index.tsxand modify it to export a component

  4. run npm run build

Derived from: