Initial commit

Author: jevakallio

.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node: ['10.x', '12.x', '14.x']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node ${{ matrix.node }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install deps and build (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test --ci --coverage --maxWorkers=2
+
+      - name: Build
+        run: yarn build

.github/workflows/size.yml

@@ -0,0 +1,12 @@
+name: size
+on: [pull_request]
+jobs:
+  size:
+    runs-on: ubuntu-latest
+    env:
+      CI_JOB_NUMBER: 1
+    steps:
+      - uses: actions/checkout@v1
+      - uses: andresz1/size-limit-action@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+*.log
+.DS_Store
+node_modules
+dist

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jani Eväkallio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,103 @@
+# TSDX User Guide
+
+Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+
+> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
+
+> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
+
+## Commands
+
+TSDX scaffolds your new library inside `/src`.
+
+To run TSDX, use:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.
+
+## Configuration
+
+Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+
+### Jest
+
+Jest tests are set up to run with `npm test` or `yarn test`.
+
+### Bundle Analysis
+
+[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
+
+#### Setup Files
+
+This is the folder structure we set up for you:
+
+```txt
+/src
+  index.tsx       # EDIT THIS
+/test
+  blah.test.tsx   # EDIT THIS
+.gitignore
+package.json
+README.md         # EDIT THIS
+tsconfig.json
+```
+
+### Rollup
+
+TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+
+### TypeScript
+
+`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+
+## Continuous Integration
+
+### GitHub Actions
+
+Two actions are added by default:
+
+- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
+- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+
+## Optimizations
+
+Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+
+```js
+// ./types/index.d.ts
+declare var __DEV__: boolean;
+
+// inside your code...
+if (__DEV__) {
+  console.log('foo');
+}
+```
+
+You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+
+## Module Formats
+
+CJS, ESModules, and UMD module formats are supported.
+
+The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+
+## Named Exports
+
+Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+
+## Including Styles
+
+There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+
+For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
+
+## Publishing to NPM
+
+We recommend using [np](https://github.com/sindresorhus/np).

bin/git-notify.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist');

package.json

@@ -0,0 +1,66 @@
+{
+  "version": "0.1.0",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=10"
+  },
+  "bin": {
+    "git-notify": "bin/git-notify.js"
+  },
+  "scripts": {
+    "start": "tsdx watch --target=node --format=cjs",
+    "build": "tsdx build --target=node --format=cjs",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "prepare": "yarn build",
+    "size": "size-limit",
+    "analyze": "size-limit --why"
+  },
+  "dependencies": {
+    "@types/git-raw-commits": "^2.0.0",
+    "boxen": "^5.0.0",
+    "chalk": "^4.1.0",
+    "git-raw-commits": "^2.0.10",
+    "meow": "^9.0.0",
+    "simple-git": "^2.35.2"
+  },
+  "peerDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "name": "git-notify",
+  "author": "Jani Eväkallio",
+  "module": "dist/git-notify.esm.js",
+  "size-limit": [
+    {
+      "path": "dist/git-notify.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/git-notify.esm.js",
+      "limit": "10 KB"
+    }
+  ],
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^4.9.2",
+    "husky": "^5.1.1",
+    "size-limit": "^4.9.2",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.1.0",
+    "typescript": "^4.2.2"
+  }
+}

src/git.ts

@@ -0,0 +1,32 @@
+import SimpleGit from 'simple-git';
+import log from 'git-raw-commits';
+import { Lifecycle } from './types';
+
+const git = SimpleGit();
+
+export function getLastRef(): Promise<string> {
+  return git
+    .raw('reflog', '--pretty=format:"%h"', '--no-patch', '-1', 'HEAD@{1}')
+    .then(value => value.replace(/"/g, ''));
+}
+
+export async function getLogStream(lifecycle: Lifecycle, args: string[]) {
+  switch (lifecycle) {
+    case 'merge':
+      return log({ from: await getLastRef() });
+
+    case 'rewrite':
+      // perhaps not the most accurate method, PRs welcome
+      return log({ from: 'origin', to: 'HEAD' });
+
+    case 'checkout':
+      const [from, to] = args;
+      return log({ from, to });
+
+    case 'since':
+      return log({ from: args[0] });
+
+    default:
+      throw new Error('[git-notify] unsupported git hook: ' + lifecycle);
+  }
+}

src/index.ts

@@ -0,0 +1,62 @@
+// import commits from 'git-raw-commits';
+import meow from 'meow';
+import showNotifications from './showNotifications';
+import { Lifecycle, Flags } from './types';
+import { getLogStream } from './git';
+
+async function hook(lifecycle: Lifecycle, args: string[], flags: Flags) {
+  // get all commit messages for the relevant revision range
+  // depending on which git hook / command was executed
+  const logs = await getLogStream(lifecycle, args);
+
+  // stream through logs and print any found notifications
+  showNotifications(logs, flags);
+}
+
+const cli = meow(
+  `
+	Usage
+	  $ git-notify <method> [options] $GIT_PARAMS
+
+  Methods
+    since <commit>  show all notifications since commit
+    merge           run on git pull/merge
+    rewrite         run on git rebase
+    checkout        run on git checkout/switch
+
+	Options
+    --prefix, -p    prefix to  look for in commit messages (default: "git-notify:")
+    --simple, -s    show a plain, unboxed notification
+    --color, -c     color of displayed notification
+
+	Examples
+    $ git-notify since HEAD~5
+    $ git-notify checkout $GIT_PARAMS
+`,
+  {
+    flags: {
+      toast: {
+        type: 'boolean',
+        alias: 't',
+      },
+      simple: {
+        type: 'boolean',
+        alias: 's',
+      },
+      prefix: {
+        type: 'string',
+        alias: 'p',
+        default: 'git-notify:',
+      },
+      color: {
+        type: 'string',
+        alias: 'c',
+        default: 'cyan',
+        description:
+          'hex value like #ff0000, or one of: black, red, green, yellow, blue, magenta, cyan, white, gray',
+      },
+    },
+  }
+);
+
+hook(cli.input[0] as Lifecycle, cli.input.slice(1), cli.flags);