.editorconfig

@@ -0,0 +1,5 @@
+root = true
+[*]
+end_of_line = lf
+indent_style = tab
+insert_final_newline = false

.github/ISSUE_TEMPLATE/issue.md

@@ -9,10 +9,10 @@ assignees: ''
 
 **Troubleshoot**
 - [ ] Before creating an issue, please check:
-https://typicode.github.io/husky/#/?id=troubleshoot
+https://typicode.github.io/husky/troubleshooting.html
 
 If you're migrating from husky 4, see:
-https://typicode.github.io/husky/#/?id=migrate-from-v4-to-v7
+https://typicode.github.io/husky/migrating-from-v4.html
 
 **Context**
 Please describe your issue and provide some context:

.github/README.md

@@ -1,78 +1,34 @@
 # husky
 
-[![Open Collective](https://opencollective.com/husky/all/badge.svg?label=financial+contributors)](https://opencollective.com/husky) [![](https://img.shields.io/npm/dm/husky.svg?style=flat)](https://www.npmjs.org/package/husky) [![Node.js CI](https://github.com/typicode/husky/workflows/Node.js%20CI/badge.svg)](https://github.com/typicode/husky/actions)
+[![](https://img.shields.io/npm/dm/husky.svg?style=flat)](https://www.npmjs.org/package/husky) [![Node.js CI](https://github.com/typicode/husky/workflows/Node.js%20CI/badge.svg)](https://github.com/typicode/husky/actions)
 
 > Modern native Git hooks made easy
 
 Husky improves your commits and more 🐶 _woof!_
 
-# Install
-
-```
-npm install husky -D
-```
-
-# Usage
-
-Edit `package.json > prepare` script and run it once:
-
-```sh
-npm set-script prepare "husky install"
-npm run prepare
-```
-
-Add a hook:
-
-```sh
-npx husky add .husky/pre-commit "npm test"
-git add .husky/pre-commit
-```
-
-Make a commit:
-
-```sh
-git commit -m "Keep calm and commit"
-# `npm test` will run every time you commit
-```
-
-_For more use cases (project in sub-directory, custom directory, CI support, ...), see documentation._
-
 ## Documentation
 
 https://typicode.github.io/husky
 
-**Important** Upgrading from v4 to v7 requires migrating previous config, please see the docs.
-
-## Articles
-
-- [Why husky has dropped conventional JS config](https://blog.typicode.com/husky-git-hooks-javascript-config/)
-- [Why husky doesn't autoinstall anymore](https://blog.typicode.com/husky-git-hooks-autoinstall/)
+**Important** Upgrading from v4 to v9 requires migrating previous config, please see the docs.
 
-## License
+## Sponsors
 
-MIT
+Support this project by becoming a sponsor [here](https://github.com/sponsors/typicode) 💖
 
-# Sponsors
+### GitHub
 
-## Companies
+<p align="center">
+  <a href="./sponsorkit/sponsors.svg">
+    <img src='./sponsorkit/sponsors.svg'/>
+  </a>
+</p>
 
-Does your company use husky? Ask your manager or marketing team if your company would be interested in supporting this project.
+### Open Collective
 
 <a href="https://opencollective.com/husky/tiers/company/0/website"><img src="https://opencollective.com/husky/tiers/company/0/avatar.svg?avatarHeight=120"></a>
 <a href="https://opencollective.com/husky/tiers/company/1/website"><img src="https://opencollective.com/husky/tiers/company/1/avatar.svg?avatarHeight=120"></a>
 <a href="https://opencollective.com/husky/tiers/company/2/website"><img src="https://opencollective.com/husky/tiers/company/2/avatar.svg?avatarHeight=120"></a>
 <a href="https://opencollective.com/husky/tiers/company/3/website"><img src="https://opencollective.com/husky/tiers/company/3/avatar.svg?avatarHeight=120"></a>
 <a href="https://opencollective.com/husky/tiers/company/4/website"><img src="https://opencollective.com/husky/tiers/company/4/avatar.svg?avatarHeight=120"></a>
-<a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a>
-<a href="https://opencollective.com/husky/tiers/company/6/website"><img src="https://opencollective.com/husky/tiers/company/6/avatar.svg?avatarHeight=120"></a>
-<a href="https://opencollective.com/husky/tiers/company/7/website"><img src="https://opencollective.com/husky/tiers/company/7/avatar.svg?avatarHeight=120"></a>
-<a href="https://opencollective.com/husky/tiers/company/8/website"><img src="https://opencollective.com/husky/tiers/company/8/avatar.svg?avatarHeight=120"></a>
-<a href="https://opencollective.com/husky/tiers/company/9/website"><img src="https://opencollective.com/husky/tiers/company/9/avatar.svg?avatarHeight=120"></a>
-
-## Individuals
-
-Find husky helpful? Become a backer and show your appreciation with a monthly donation on [Open Collective](https://opencollective.com/husky). You can also tip with a one-time donation.
-
-<a href="https://opencollective.com/husky" target="_blank"><img src="https://opencollective.com/husky/tiers/individual.svg?avatarHeight=32"/></a>
-
-GitHub sponsors can be viewed on my [profile](https://github.com/typicode). All past and current Open Collective sponsors can be viewed on [here](https://opencollective.com/husky).
+<a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a>

.github/workflows/deploy.yml

@@ -0,0 +1,36 @@
+name: Deploy
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+      - run: npm ci
+      - name: Build
+        run: npx vitepress build
+      - uses: actions/configure-pages@v2
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/.vitepress/dist
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/node.js.yml

@@ -1,28 +1,24 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
 name: Node.js CI
 
 on: [push]
 
-jobs:
-  build:
-    name: Test on node ${{ matrix.node-version }} and ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
 
+jobs:
+  test:
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-
+        node-version: [18, 20]
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - name: npm 7
-      run: npm i -g npm@7
-    - run: npm ci --ignore-scripts
-    - run: npm test
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm --version
+      - run: npm ci --ignore-scripts
+      - run: ./test.sh

.github/workflows/npm_publish.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: ./test.sh
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,5 +1,8 @@
-lib
 node_modules
-husky-*.tgz
-tsconfig.tsbuildinfo
 *.log
+docs/.vitepress/cache
+docs/.vitepress/dist
+docs/.env
+docs/sponsorkit/.cache.json
+docs/sponsorkit/sponsors.json
+docs/sponsorkit/sponsors.png

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm test
+./test.sh

.npmignore

@@ -0,0 +1,3 @@
+.*
+test*
+docs

.shellcheckrc

@@ -0,0 +1 @@
+disable=SC1090,SC2164

README.md

@@ -1,38 +1 @@
-# husky
-
-> Modern native Git hooks made easy
-
-Husky improves your commits and more 🐶 *woof!*
-
-# Install
-
-```
-npm install husky --save-dev
-```
-
-# Usage
-
-Edit `package.json > prepare` script and run it once:
-
-```sh
-npm set-script prepare "husky install"
-npm run prepare
-```
-
-Add a hook:
-
-```sh
-npx husky add .husky/pre-commit "npm test"
-git add .husky/pre-commit
-```
-
-Make a commit:
-
-```sh
-git commit -m "Keep calm and commit"
-# `npm test` will run
-```
-
-# Documentation
-
 https://typicode.github.io/husky

bin.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import f, { writeFileSync as w } from 'fs'
+import i from './index.js'
+
+let a = process.argv[2]
+
+if (a == 'init') {
+  let p = process.env.npm_package_json
+  let d = JSON.parse(f.readFileSync(p))
+  d.scripts.prepare = 'husky'
+  w('package.json', JSON.stringify(d, null, /\t/.test() ? '\t' : 2))
+  process.stdout.write(i())
+  w('.husky/pre-commit', process.env.npm_config_user_agent.split('/')[0] + ' test')
+  process.exit()
+}
+
+let d = c => console.error(`${c} command is deprecated`)
+if (['add', 'set', 'uninstall'].includes(a)) { d(a); process.exit(1) }
+if (a == 'install') d(a)
+
+process.stdout.write(i(a == 'install' ? undefined : a))

docs/.vitepress/config.mts

@@ -0,0 +1,25 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Husky",
+  description: "Git hooks made easy",
+  base: '/husky/',
+  themeConfig: {
+    // outline: [2, 3],
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/typicode/husky' },
+    ],
+    carbonAds: {
+      code: 'CWYDP53L',
+      placement: 'typicodegithubio',
+    },
+    sidebar: [
+      { text: 'Introduction', link: '/' },
+      { text: 'Get Started', link: '/get-started' },
+      { text: 'How To', link: '/how-to' },
+      { text: 'Troubleshoot', link: '/troubleshoot' },
+      { text: 'Migrate from v4', link: '/migrate-from-v4' },
+    ],
+  }
+})