Skip to content

mcous/js

Repository files navigation

@mcous/js

My common configurations and GitHub Actions for JavaScript and TypeScript projects:

Tool Configurations

Tool NPM Module Version
ESLint @mcous/eslint-config eslint version
Prettier @mcous/prettier-config prettier version
TypeScript @mcous/typescript-config typescript version

Actions

Action Path Description
Set up Node mcous/js/actions/setup Install Node, pnpm, and dependencies with caching

Contributing

Node.js v18 or higher is required to work on this repository. To get started, clone the repository and install the project's development dependencies using corepack and pnpm.

corepack enable
git clone https://github.com/mcous/js.git
cd js
pnpm install

Once your development dependencies are installed, you can verify that all checks and tests are passing:

# run all checks and builds
pnpm all

# build publish artifacts
pnpm build

# auto-format (modifies files)
pnpm format

# lint and check formatting
pnpm lint

Releasing

Modules in this repository are continuously deployed to npm from the main branch. To trigger a release, create a commit that bumps version in one or more package.json files and create a pull request to merge that commit into main.