build: add automated releases and pre-commit hooks

.commitlintrc.json

@@ -1 +1,3 @@
-{ "extends": ["@commitlint/config-conventional"] }
+{
+ "extends": ["@commitlint/config-conventional"]
+}

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: 'publish'
+
+on:
+ push:
+ branches: [master]
+
+jobs:
+ publish:
+ needs: ci
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ persist-credentials: false
+ - uses: actions/setup-node@v3
+ with:
+ node-version: latest
+ - run: npm install
+ - run: npx semantic-release
+ env:
+ GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+ ci:
+ needs: get-supported-node-versions
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - name: Use latest version of Node.js
+ uses: actions/setup-node@v3
+ with:
+ node-version: latest
+ - run: npm install
+ - run: npm run lint:commit -- --to "${{ github.sha }}"
+ - run: npm run lint:standard
+ - run: npm run lint:ts-standard
+ - run: npm run test
+

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run test
+npm run lint:standard -- --fix
+npm run lint:ts-standard -- --fix

.npmignore

@@ -5,6 +5,11 @@
 .editorconfig
 .github
 .prettierignore
+.commitlintrc.json
+.releaserc.yml
+.husky/
+CONTRIBUTING.md
+eslintrc.json
 coverage/
 node_modules/
 src/

.releaserc.yml

@@ -0,0 +1,44 @@
+branches:
+ - master
+plugins:
+ - - "@semantic-release/commit-analyzer"
+ - releaseRules:
+ - breaking: true
+ release: major
+ - revert: true
+ release: patch
+ - type: feat
+ release: minor
+ - type: fix
+ release: patch
+ - type: perf
+ release: patch
+ - type: docs
+ release: patch
+ - - "@semantic-release/release-notes-generator"
+ - preset: conventionalcommits
+ presetConfig:
+ types:
+ - type: build
+ section: Build system / dependencies
+ - type: ci
+ section: CI
+ - type: docs
+ section: Documentation
+ - type: feat
+ section: Features
+ - type: fix
+ section: Bug fixes
+ - type: perf
+ section: Performance
+ - type: refactor
+ section: Refactoring
+ - type: text
+ section: Testing
+ - "@semantic-release/changelog"
+ - "@semantic-release/github"
+ - "@semantic-release/npm"
+ - - "@semantic-release/git"
+ - assets:
+ - CHANGELOG.md
+ - package.json

CHANGELOG.md

@@ -1,7 +1,5 @@
 # Changelog
 
-## 13.0.0 - Pending
-
 ## 12.0.2
 
 - **Fix:** Allow absolute `--project` path [(#269)](https://github.com/standard/ts-standard/pull/269).

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+I welcome all pull requests. Please make sure you add appropriate test cases for any features
+added.
+
+> New to contributing? Check out [this How to Contribute guide](https://opensource.guide/how-to-contribute/).
+
+## Setup
+
+It is assumed that you already have a copy of this project.
+
+To setup your development environment, run the following command inside the project folder:
+
+```sh
+npm install
+```
+
+This will install the required tools, dependencies, and git hooks.
+
+## Committing
+
+We follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and this is enforced by commitlint. Commits with incorrectly formatted messages will result in an error from git and the commit to be rejected.
+
+When committing, tests and linters are also run. If any of them fail, git will throw an error and the commit will be rejected.
+
+> Note that linters are run with the `--fix` argument, so any fixable issues will be fixed automatically.

README.md

@@ -86,10 +86,7 @@ You can add an `ignore` property to your `package.json` `ts-standard` configurat
 ```json
 {
  "ts-standard": {
- "ignore": [
- "dist",
- "src/**/*.js"
- ]
+ "ignore": ["dist", "src/**/*.js"]
  }
 }
 ```
@@ -119,10 +116,6 @@ Special thanks to [`standard`](https://github.com/standard/standard) for inspira
 to [`eslint-config-standard-with-typescript`](https://github.com/standard/eslint-config-standard-with-typescript) for
 creating a typescript specific standard.
 
-## 📋 Contributing Guide
+## 📋 Contributing
 
-I welcome all pull requests. Please make sure you add appropriate test cases for any features
-added. Before opening a PR please make sure to run the following scripts:
-
-- `npm run lint:standard` checks for code errors and format according to [standard](https://github.com/standard/standard)
-- `npm test` make sure all tests pass
+See [CONTRIBUTING.md](./CONTRIBUTING.md)

package.json

@@ -16,6 +16,10 @@
  "author": "Todd Bluhm",
  "license": "MIT",
  "homepage": "https://github.com/standard/ts-standard",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/standard/ts-standard.git"
+ },
  "keywords": [
  "TypeScript Standard Style",
  "check",
@@ -47,9 +51,10 @@
  ]
  },
  "scripts": {
+ "prepare": "husky install",
  "lint:standard": "standard",
  "lint:ts-standard": "node cli.js",
- "lint:commit": "commitlint",
+ "lint:commit": "commitlint --from \"7b4219a67b4fe94b1a1487b7d545d0cc7742f770\"",
  "test": "tape test/*.js"
  },
  "peerDependencies": {
@@ -72,9 +77,18 @@
  "devDependencies": {
  "@commitlint/cli": "^17.0.3",
  "@commitlint/config-conventional": "^17.0.3",
+ "@semantic-release/changelog": "^6.0.3",
+ "@semantic-release/git": "^10.0.1",
+ "@semantic-release/github": "^8.0.7",
+ "@semantic-release/npm": "^10.0.3",
  "@types/minimist": "^1.2.2",
  "@types/node": "^18.0.6",
+ "husky": "^8.0.3",
+ "semantic-release": "^21.0.2",
  "standard": "^17.0.0",
  "tape": "^5.5.3"
+ },
+ "publishConfig": {
+ "provenance": true
  }
 }