Skip to content

Latest commit

 

History

History
219 lines (120 loc) · 12.5 KB

README.md

File metadata and controls

219 lines (120 loc) · 12.5 KB
Raw

Using this template

This is my template repository to use when creating new npm packages written in TypeScript. The top section of this readme is for how to use it to start a new package, and should be removed as part of the setup process.

Setup

You will need to install Node.js before using this template.

  1. Click "Use this template" to create a new repository based on this one.
  2. Update the package.json file to reflect your new package's details.
  3. Update names throughout the package. a. Replace base-package with the name of your package as it is used in code. b. Replace Base Package Replace with the name of your package as it is used in documentation. c. Rename src/main-export.ts and replace main-export with the name of your main entry point file. d. Optionally rename docs/assets/js/src/docs-script.ts and replace docs-script with the name of your documentation script and its associated entry point. e. Optionally, remove @cipscis/ from everywhere it appears if this package won't be published beneath a scope. f. If you're not me, replace @cipscis with your npm username and then cipscis with your GitHub username, and be sure to also update the author property in the package.json.
  4. Create a .env file. See .env for more information.
  5. Run npm install.
  6. Update this README.md file and the CHANGELOG.md file to remove the instruction sections.

Now you're ready to work on code in this package.

Usage

Using the files specified in package.json, you can create a package to be installed with npm.

In the docs folder, which can be deployed to GitHub Pages but is not included when your package is installed, you can document your package. Webpack is configured to have an alias for your main entry point so you can load it as though it were installed from npm, e.g. import { foo } from '@cipscis/base-package';

Once you have an initial version of your package ready to push, you will want to update the version attribute of your package.json file to "1.0.0". See Semantic Versioning for more information on version numbers.

You should also update the CHANGELOG.md file to describe your changes. This is particularly important after your initial 1.0.0 version.

Then, you can run npm publish to publish your package. Once published, you can run npm install @cipscis/base-package to install the package in other projects.

Structure

Frontend assets

By default, your package consists of the contents of the dist folder. This folder is populated when the contents of the src folder are compiled using tsc, which happens automatically prior to publishing. The src folder contains a single TypeScript file called main-export.ts. You can rename this file, but if you do make sure you update the browser property in your package.json file. If your package doesn't need to be run in a browser, you should change this property to main.

Assets used for the package's documentation, such as CSS and JavaScript, are contained in /docs/assets. In here, the contents of the scss folder are used to compile CSS files into the css folder.

The /docs/assets/js folder contains a src folder and a dist folder. Any JavaScript or TypeScript files inside the src folder are bundled into the dist folder. By default, Webpack is configured to look for a single entry point at /docs/assets/js/src/docs-script.ts, which is bundled into /docs/assets/js/dist/docs-script.bundle.js. You can use either JavaScript or TypeScript entry points for your documentation.

Backend assets

The Node.js server run using Express has its files inside the /server directory. By default, this just runs a static http server that serves files in the /docs directory, but it can be extended to add additional functionality.

This server only runs locally, so any additional functionality will not be available on GitHub Pages.

Configuration

package.json

By default, the package.json file is configured to set the project to be of type module. This means NodeJS will use ES module syntax as opposed to its default CommonJS syntax, allowing the use of import and export keywords.

For more information on the differences, see Differences between ES modules and CommonJS

Linting

Both eslint and stylelint configuration files can be found within the config folder.

Tests

The Jest-based test suite is configured in jest.config.ts. No custom test name matcher is specified, which means Jest's default matcher will be used:

By default it looks for .js, .jsx, .ts and .tsx files inside of __tests__ folders, as well as any files with a suffix of .test or .spec (e.g. Component.test.js or Component.spec.js). It will also find files called test.js or spec.js.

.env

See .env for information on setting up a .env file.

GitHub Pages

This project is set up to use a GitHub Action every time new code is pushed to the main branch. This build-and-deploy workflow runs the build npm script, then runs the test script, then if the tests passed it deploys the contents of the docs directory by committing them to a gh-pages branch. This gh-pages branch should be configured in GitHub to be published to GitHub Pages.

When publishing a project using GitHub Pages, the project usually appears at a URL with a path, such as https://cipscis.github.io/base-package. This means using root relative URLs such as /assets/css/main.css would work locally, but would break when the project is published on GitHub Pages.

To fix this, the local Node.js server looks for a PROJECT_NAME variable in your .env file. If it finds one, it sets up redirects so URLs starting with /${PROJECT_NAME} can be used as though they were root relative, so they will find your assets.

By default, the index.html file is configured to be published to GitHub Pages under the project name base-package. When you use it as a base for your own project, you will need to update these URLs.

Delete everything above here when creating a new package

base-package

Build and deploy status badge

Install

Run npm install @cipscis/base-package

Usage

See Base Package documentation

Development

You will need to install Node.js before working on this package.

  1. Clone the repository using git clone https://github.com/cipscis/base-package.git.
  2. Run npm install to install development dependencies.
  3. Create a .env file.
  4. Run npm start to run the local server and watch CSS and JS files for changes.

Usually, you will just want to run npm start, but this project also provides the following npm scripts:

  • npm run server runs a Node.js server on the port specified in the .env file, using Express.

  • npm run build compiles CSS files using sass, then typechecks TypeScript using the TypeScript compiler and bundles TypeScript and any JavaScript using esbuild.

  • npm run watch compiles both CSS and TypeScript+JavaScript files just like npm run build, but in watch mode so any further changes will result in recompilation. Also runs any configured tests suites in watch mode.

  • npm run lint lints all JavaScript and TypeScript files using eslint and all SCSS files using stylelint.

  • npm start runs both the server and watch tasks simultaneously.

  • npm test runs any configured test suites using Jest.

  • npm run testCoverage runs any configured test suites using Jest, and reports coverage information.

  • npm run testWatch runs any configured test suites using Jest in watch mode.

.env

The .env file contains the following environment variables:

  • PROJECT_NAME (string)

If present, used by Express to set up redirects for emulating GitHub Pages.

  • MODE (string 'development' | 'production')

Used by Webpack to determine what optimisations to use and how to generate sourcemaps.

  • PORT (int)

Used by Express to determine which port to use when running a local Node.js server.

An example .env file you can use for development is:

PROJECT_NAME = "base-package"
MODE = "development"
PORT = "8080"

This file is intended to differ from environment to environment, so it is ignored by Git.

Dependencies

None.

Dev Dependencies

Development

These dependencies are used when working on the project locally.

Deploy

These dependencies are used for deploying the project to GitHub Pages.

  • checkout: Used to check out the repository to a workspace so it can be built

  • setup-node: Use to set up a Node.JS environment for the build and test scripts to run on during the deployment process.

  • Deploy to GitHub Pages: Used to deploy the project to GitHub pages once it has been built