make-js-lib
is a cli that creates a JavaScript library from a template.
When run it does the following:
- Creates a project folder
- Adds files from template
- Installs dependencies
- Makes a commit
-
typescript
- TypeScript is a superset of JavaScript that compiles to clean JavaScript output. -
np
- A betternpm publish
-
ava
- Node.js test runner that lets you develop with confidence 🚀 -
xo
- ❤️ JavaScript/TypeScript linter (ESLint wrapper) with great defaults -
esbuild-runner
- ⚡️ Super-fast on-the-fly transpilation of modern JS, TypeScript and JSX using esbuild -
package-preview
- Creates a production preview of a package
npx make-js-lib <library-name>
If you intend to publish this to npm
, then you should check the availability of your name with npm-name-cli
:
npx npm-name-cli <library-name>
-
Add a license: https://help.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository
-
Update the repository url field in package.json:
"repository": {
"type": "git",
"url": "git+https://github.com/sajmoni/make-js-lib.git"
},
This is required for np
to be able to publish a changelog
-
Update the
keywords
section inpackage.json
, this helps people find your package onnpm
. -
Add or remove badges: https://badgen.net/
-
Add GitHub issue and PR templates: https://help.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates