cleanup

Author: metachris

.github/workflows/lint-and-test.yml

@@ -18,6 +18,7 @@ jobs:
         node-version: ${{ matrix.nodejs }}
 
     - run: yarn install
-    - run: yarn lint
+    - run: yarn add -D esbuild
     - run: yarn test
-    - run: yarn build
+    - run: yarn lint
+    - run: yarn build-all

.gitlab-ci.yml

@@ -12,19 +12,20 @@ lint-and-test:
   stage: test
   script:
     - yarn install
-    - yarn build
+    - yarn add -D esbuild
     - yarn test
     - yarn lint
+    - yarn build-all
 
 # Deploy docs to Gitlab pages
-# pages:
-#   stage: deploy
-#   only:
-#     - master
-#   script:
-#     - yarn install
-#     - yarn docs
-#     - mv docs public
-#   artifacts:
-#     paths:
-#       - public
+pages:
+  stage: deploy
+  only:
+    - master
+  script:
+    - yarn install
+    - yarn docs
+    - mv docs public
+  artifacts:
+    paths:
+      - public

.npmignore

@@ -8,6 +8,7 @@
 
 coverage
 *.log
+.gitlab-ci.yml
 
 package-lock.json
 /*.tgz

README.md

@@ -1,40 +1,33 @@
-# TypeScript Project Boilerplate
+# TypeScript Boilerplate for 2021
 
-TypeScript project with modern tooling (March 2021) to get started quickly and right-footed. Ideal for quick projects as well as npm packages.
+[![Build and test status](https://github.com/metachris/typescript-boilerplate/workflows/Lint%20and%20test/badge.svg)](https://github.com/metachris/micropython-ctl/actions?query=workflow%3A%22Build+and+test%22)
 
-Batteries included:
+Get started quickly and right-footed
 
-* TypeScript 4, optionally [esbuild](https://esbuild.github.io/)
+TypeScript project boilerplate with modern tooling, targetting for Node.js and browser.
+
+* [TypeScript](https://www.typescriptlang.org/) 4
+* Optionally [esbuild](https://esbuild.github.io/) - to bundle for browsers and Node.js
 * Linting with [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) ([tslint](https://palantir.github.io/tslint/) is deprecated)
-* Tests with [Jest](https://jestjs.io/docs/getting-started) (and [ts-jest](https://www.npmjs.com/package/ts-jest))
-* CI for testing and linting ([GitHub Actions](https://docs.github.com/en/actions) / [Gitlab CI](https://docs.gitlab.com/ee/ci/))
-* Automatic API documentation with [typedoc](https://typedoc.org/guides/doccomments/)
-* Building a browser-compatible module with [esbuild](https://esbuild.github.io/) or [webpack](https://webpack.js.org/)
+* Testing with [Jest](https://jestjs.io/docs/getting-started) (and [ts-jest](https://www.npmjs.com/package/ts-jest))
+* Publishing to npm
+* Continuous integration ([GitHub Actions](https://docs.github.com/en/actions) / [GitLab CI](https://docs.gitlab.com/ee/ci/))
+* Automatic API documentation with [TypeDoc](https://typedoc.org/guides/doccomments/)
 
-See also the [introduction blog post](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/).
+See also the introduction blog post: [Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/).
 
 
 ## Getting Started
 
 * Clone the repository (you can also click "Use this template")
 * Edit `package.json` and `tsconfig.json` to your liking
 * Now you can run `yarn run`, `yarn lint`, `yarn test`, `yarn build` and `yarn ts-node <filename>`.
+* Take a look at all the scripts in [`package.json`](https://github.com/metachris/typescript-boilerplate/blob/master/package.json)
 * For publishing to npm, use `yarn publish` (or `npm publish`)
 
-### Want documentation, published to GitHub or GitLab pages?
-
-You can auto-generate API documentation from the TyoeScript source files using [typedoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI:
+## esbuild
 
-* Install [typedoc](https://typedoc.org/guides/doccomments/): `yarn add -D typedoc`
-* Add `docs` script to `package.json`: `"docs": "typedoc --entryPoints src/main.ts"`
-* You can now generate the documentation with `yarn docs`. The resulting HTML is saved in `docs/`.
-* Publish to pages through CI:
-  * [GitHub pages](https://pages.github.com/): uncomment content of `.github/workflows/deploy-gh-pages.yml` and enable pages in GitHub repo settings
-  * [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): uncomment deploy task in `.gitlab-ci.yml`
-
-### esbuild
-
-You can use [esbuild](https://esbuild.github.io/) instead of the default TypeScript compiler (`tsc`) to build and bundle the output for node and browsers.
+You can use [esbuild](https://esbuild.github.io/) to bundle for browsers (and Node.js if you want).
 `esbuild` is an extremely fast bundler that supports a [large part of the TypeScript syntax](https://esbuild.github.io/content-types/#typescript).
 
 ```bash
@@ -45,23 +38,38 @@ yarn add -D esbuild
 ./node_modules/.bin/esbuild src/cli.ts --bundle --platform=node --outfile=dist/esbuild/cli.js
 
 # Build for browsers
-./node_modules/.bin/esbuild src/browser.ts --bundle --outfile=dist/browser.js
+./node_modules/.bin/esbuild src/browser.ts --bundle --outfile=dist/esbuild/browser.js
 ```
 
+You can build everything with `yarn build`. Read more about the esbuild setup [here](TODO).
+
+## Documentation, published to GitHub or GitLab pages
+
+You can auto-generate API documentation from the TyoeScript source files using [typedoc](https://typedoc.org/guides/doccomments/). The generated documentation can be published to GitHub / GitLab pages through the CI:
+
+* Install [typedoc](https://typedoc.org/guides/doccomments/): `yarn add -D typedoc`
+* Add `docs` script to `package.json`: `"docs": "typedoc --entryPoints src/main.ts"`
+* You can now generate the documentation with `yarn docs`. The resulting HTML is saved in `docs/`.
+* Publish to pages through CI:
+  * [GitHub pages](https://pages.github.com/): uncomment content of `.github/workflows/deploy-gh-pages.yml` and enable pages in GitHub repo settings
+  * [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/): uncomment deploy task in `.gitlab-ci.yml`
+
+For example the documentation for this project: https://metachris.github.io/typescript-boilerplate/
+
 ## References
 
-* [Blog post: Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)
+* **[Blog post: Starting a TypeScript Project in 2021](https://www.metachris.com/2021/03/bootstrapping-a-typescript-node.js-project/)**
 * [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/intro.html)
-* [esbuild docs](https://esbuild.github.io/)
 * [tsconfig docs](https://www.typescriptlang.org/tsconfig)
+* [esbuild docs](https://esbuild.github.io/)
 * [typescript-eslint docs](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md)
 * [Jest docs](https://jestjs.io/docs/getting-started)
 * [GitHub Actions](https://docs.github.com/en/actions), [GitLab CI](https://docs.gitlab.com/ee/ci/)
 
 
 ## Feedback
 
-Please post your feedback and/or ideas:
+Reach out with feedback and ideas:
 
 * [twitter.com/metachris](https://twitter.com/metachris)
-* [Create a new issue](https://github.com/metachris/typescript-nodejs-boilerplate/issues)
+* [Create a new issue](https://github.com/metachris/typescript-boilerplate/issues)

browser-test.html

@@ -1,6 +1,7 @@
 <html>
   <head>
     <script src="./dist/esbuild/browser.js"></script>
+    <!-- <script src="https://cdn.jsdelivr.net/npm/typescript-boilerplate-2021"></script> -->
   </head>
   <body>
     Open the devtools 👇

package.json

@@ -3,7 +3,7 @@
   "version": "0.3.0",
   "description": "Boilerplate for a TypeScript library",
   "author": "Chris Hager <chris@linuxuser.at>",
-  "repository": "https://github.com/metachris/typescript-nodejs-boilerplate",
+  "repository": "https://github.com/metachris/typescript-boilerplate",
   "license": "MIT",
   "main": "./dist/tsc/main.js",
   "types": "./dist/tsc/main.d.ts",
@@ -12,7 +12,7 @@
     "my-cli-tool": "./dist/esbuild/cli.js"
   },
   "scripts": {
-    "start": "ts-node src/main.ts",
+    "cli": "ts-node src/cli.ts",
     "lint": "eslint src/ --ext .js,.jsx,.ts,.tsx",
     "test": "jest",
     "clean": "rm -rf dist build package",