Changeset and version management with changesets (#747)

Use `changesets` as version and changelog manager

* Publish `simple-git` from the package root by including `/dist/` in export paths once published.
* Use named root import in (deprecated) `simple-git/promise` types
* Use `filterType` in `parseLogOptions` to provide the type guard for passing in a standard `Options` object as well as a `LogOptions` object

Author: steveukx

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/tiny-dolls-impress.md

@@ -0,0 +1,5 @@
+---
+"simple-git": minor
+---
+
+Switch to `changesets` as version and changelog manager

.github/workflows/changesets.yml

@@ -0,0 +1,27 @@
+name: release-changesets
+
+on:
+   push:
+      branches:
+         - main
+
+jobs:
+   release:
+      runs-on: ubuntu-latest
+      steps:
+        -  name: Checkout Repo
+           uses: actions/checkout@v2
+           with:
+             fetch-depth: 0
+
+        -  uses: actions/setup-node@v2
+           with:
+               node-version: 16
+
+        -  run: yarn --frozen-lockfile
+        -  run: yarn build
+
+        -  uses: changesets/action@v1
+           env:
+               GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+               NPM_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

.github/workflows/ci.yml

@@ -18,10 +18,8 @@ jobs:
            uses: actions/setup-node@v1
            with:
              node-version: ${{ matrix.node-version }}
-         - name: Node Version
-           run: node --version
-         - name: Git Version
-           run: git --version
+         - run: node --version
+         - run: git --version
          - name: Cache node_modules
            id: cache-modules
            uses: actions/cache@v1

.github/workflows/release-please.yml

@@ -14,7 +14,9 @@
     "clean": "git clean -fxd -e .idea -e node_modules",
     "test": "lerna run test"
   },
-  "devDependencies": {
+  "dependencies": {
+    "@changesets/changelog-github": "^0.4.2",
+    "@changesets/cli": "^2.20.0",
     "lerna": "^4.0.0"
   }
 }

.release-please-manifest.json

@@ -3,13 +3,14 @@ const {existsSync} = require('fs');
 
 function resolver () {
    const root = resolve(__dirname, '../..', 'simple-git');
-   const dist = resolve(root, 'dist');
+   const dist = resolve(root, 'dist', 'cjs');
 
    const pkg = existsSync(dist) ? dist : root;
 
    return ['module-resolver', {
       root: [pkg],
       alias: {
+         'simple-git/promise': resolve(root, 'promise'),
          'simple-git': pkg,
       },
    }];

package.json

@@ -8,8 +8,6 @@
     "esModuleInterop": true,
     "baseUrl": ".",
     "paths": {
-      "simple-git": ["../../simple-git/dist", "../../simple-git"],
-      "simple-git/*": ["../../simple-git/dist/*", "../../simple-git/*"],
     }
   }
 }

packages/babel-config/babel.config.js

@@ -1,7 +1,6 @@
 {
   "name": "simple-git",
   "description": "Simple GIT interface for node.js",
-  "private": true,
   "version": "3.1.1",
   "author": "Steve King <[email protected]>",
   "contributors": [
@@ -55,30 +54,26 @@
   },
   "types": "./typings/index.d.ts",
   "files": [
-    "promise.js",
-    "promise.d.ts",
-    "src/**/*.d.ts",
-    "typings",
+    "promise.*",
     "dist"
   ],
   "scripts": {
-    "build": "yarn build:compile && yarn build:defs && yarn build:promise && yarn build:docs && yarn build:pkg",
+    "build": "yarn build:compile && yarn build:defs",
     "build:compile": "node scripts/build.js",
     "build:defs": "tsc -p tsconfig.release.json --outDir dist && cp -r typings dist",
     "build:pkg": "node scripts/package-json.js",
-    "build:promise": "cp promise.* dist",
-    "build:docs": "cp ../*.md ../LICENSE dist",
-    "preversion": "yarn test && yarn build",
+    "build:docs": "cp ../readme.md .",
+    "prepublishOnly": "yarn build:docs && yarn build:pkg",
     "test": "jest --coverage"
   },
   "publish": {
-    "private": false,
-    "main": "cjs/index.js",
-    "module": "esm/index.js",
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "./dist/typings/index.d.ts",
     "exports": {
       ".": {
-        "import": "./esm/index.js",
-        "require": "./cjs/index.js"
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
       },
       "./promise": {
         "require": "./promise.js"

packages/test-typescript-consumer/tsconfig.json

@@ -1,7 +1,4 @@
-import * as errors from './typings/errors';
-import * as types from './typings/types';
-import * as resp from './typings/response';
-import * as simpleGit from './typings/simple-git';
+import * as SimpleGitTypes from 'simple-git';
 
 /**
  * @deprecated
@@ -17,7 +14,7 @@ declare const simplegit: simplegit.SimpleGitExport;
 declare namespace simplegit {
 
    type SimpleGitExport = ((basePath?: string) => simplegit.SimpleGit) & {
-      CleanOptions: typeof types.CleanOptions
+      CleanOptions: typeof SimpleGitTypes.CleanOptions
    };
 
    /**
@@ -29,36 +26,36 @@ declare namespace simplegit {
     *
     * To upgrade, change all 'simple-git/promise' imports to just 'simple-git'
     */
-   type SimpleGit = simpleGit.SimpleGit;
+   type SimpleGit = SimpleGitTypes.SimpleGit;
 
    // errors
-   type GitError = errors.GitError;
-   type GitConstructError = errors.GitConstructError;
-   type GitResponseError<T> = errors.GitResponseError<T>;
-   type TaskConfigurationError = errors.TaskConfigurationError;
+   type GitError = SimpleGitTypes.GitError;
+   type GitConstructError = SimpleGitTypes.GitConstructError;
+   type GitResponseError<T> = SimpleGitTypes.GitResponseError<T>;
+   type TaskConfigurationError = SimpleGitTypes.TaskConfigurationError;
 
    // responses
-   type BranchSummary = resp.BranchSummary
-   type CleanSummary = resp.CleanSummary;
-   type CleanMode = types.CleanMode;
-   type DiffResult = resp.DiffResult;
-   type FetchResult = resp.FetchResult;
-   type CommitResult = resp.CommitResult;
-   type MergeResult = resp.MergeResult;
-   type PullResult = resp.PullResult;
-   type StatusResult = resp.StatusResult;
-   type TagResult = resp.TagResult;
+   type BranchSummary = SimpleGitTypes.BranchSummary
+   type CleanSummary = SimpleGitTypes.CleanSummary;
+   type CleanMode = SimpleGitTypes.CleanMode;
+   type DiffResult = SimpleGitTypes.DiffResult;
+   type FetchResult = SimpleGitTypes.FetchResult;
+   type CommitResult = SimpleGitTypes.CommitResult;
+   type MergeResult = SimpleGitTypes.MergeResult;
+   type PullResult = SimpleGitTypes.PullResult;
+   type StatusResult = SimpleGitTypes.StatusResult;
+   type TagResult = SimpleGitTypes.TagResult;
 
    // types
-   type outputHandler = types.outputHandler
-   type LogOptions<T = types.DefaultLogFields> = types.LogOptions<T>;
-   type Options = types.Options;
+   type outputHandler = SimpleGitTypes.outputHandler
+   type LogOptions<T = SimpleGitTypes.DefaultLogFields> = SimpleGitTypes.LogOptions<T>;
+   type Options = SimpleGitTypes.Options;
 
    // deprecated
    /** @deprecated use MergeResult */
-   type MergeSummary = resp.MergeSummary;
+   type MergeSummary = SimpleGitTypes.MergeSummary;
    /** @deprecated use CommitResult */
-   type CommitSummary = resp.CommitResult;
+   type CommitSummary = SimpleGitTypes.CommitResult;
 }
 
 /**

release-please-config.json

@@ -4,7 +4,6 @@ const { logger } = require('./log');
 
 const log = logger('package.json');
 const src = resolve(__dirname, '..', 'package.json');
-const out = resolve(__dirname, '..', 'dist', 'package.json');
 
 (async function () {
    log('Generating content');
@@ -16,14 +15,14 @@ const out = resolve(__dirname, '..', 'dist', 'package.json');
 
 function save (content) {
    return new Promise((done, fail) =>
-      writeFile(out, JSON.stringify(content, null, 2), 'utf8', (err) => {
+      writeFile(src, JSON.stringify(content, null, 2), 'utf8', (err) => {
          err ? fail(err) : done();
       })
    );
 }
 
 function createPackageJson() {
-   const { publish, scripts, files, ...pkg } = require(src);
+   const { publish, scripts, ...pkg } = require(src);
 
    return {
       ...pkg,

simple-git/package.json

@@ -9,6 +9,7 @@ import {
 import {
    appendTaskOptions,
    filterArray,
+   filterPrimitives,
    filterString,
    filterType,
    trailingFunctionArgument,
@@ -62,7 +63,7 @@ interface ParsedLogOptions {
    commands: string[]
 }
 
-function prettyFormat(format: { [key: string]: string | unknown }, splitter: string): [string[], string] {
+function prettyFormat(format: Record<string, string | unknown>, splitter: string): [string[], string] {
    const fields: string[] = [];
    const formatStr: string[] = [];
 
@@ -76,19 +77,18 @@ function prettyFormat(format: { [key: string]: string | unknown }, splitter: str
    ];
 }
 
-function userOptions<T>(input: T): Exclude<Omit<T, keyof typeof excludeOptions>, undefined> {
-   const output = {...input};
-   Object.keys(input).forEach(key => {
-      if (key in excludeOptions) {
-         delete output[key as keyof T];
+function userOptions<T extends Options>(input: T): Options {
+   return Object.keys(input).reduce((out, key) => {
+      if (!(key in excludeOptions)) {
+         out[key] = input[key];
       }
-   });
-   return output;
+      return out;
+   }, {} as Options);
 }
 
-export function parseLogOptions<T extends Options>(opt: LogOptions<T> = {}, customArgs: string[] = []): ParsedLogOptions {
-   const splitter = opt.splitter || SPLITTER;
-   const format = opt.format || {
+export function parseLogOptions<T extends Options>(opt: Options | LogOptions<T> = {}, customArgs: string[] = []): ParsedLogOptions {
+   const splitter = filterType(opt.splitter, filterString, SPLITTER);
+   const format = !filterPrimitives(opt.format) && opt.format ? opt.format : {
       hash: '%H',
       date: opt.strictDate === false ? '%ai' : '%aI',
       message: '%s',
@@ -116,11 +116,11 @@ export function parseLogOptions<T extends Options>(opt: LogOptions<T> = {}, cust
       suffix.push(`${opt.from}${rangeOperator}${opt.to}`);
    }
 
-   if (opt.file) {
+   if (filterString(opt.file)) {
       suffix.push('--follow', opt.file);
    }
 
-   appendTaskOptions(userOptions(opt), command);
+   appendTaskOptions(userOptions(opt as Options), command);
 
    return {
       fields,