pastoralist 0.1.4 → 0.1.7

package/README.md

@@ -3,14 +3,16 @@
 ![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript&label&labelColor=blue&color=555555)
 ![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fyowainwright%2Fpastoralist)
 
-A tool to watch over node module \***`overrides and resolutions`** 🐑 👩🏽‍🌾
+A tool to watch over node module **`*overrides and resolutions`** 🐑 👩🏽‍🌾
 
-> \***overrides and resolutions** solve the same problem-they give developers a way to specify the dependency versions downloaded to repository's `node_modules`. This is very convenient for setting dependency dependencies to specific versions to fix security issues. However, it is easy to lose track of why an override or resolution is specified. This is an inconvenient problem when trying to maintain useable dependencies over time—until now.
+> \***overrides and resolutions**
+>
+> Overrides and resolutions solve the same problem-they give developers a way to specify the dependency versions downloaded to repository's `node_modules`. This is very convenient for setting dependency dependencies to specific versions to fix security issues. However, it is easy to lose track of why an override or resolution is specified. This is an inconvenient problem when trying to maintain useable dependencies over time—until now.
 
 ---
 ## Synopsis
 
-By using **Pastoralist** in a `pre-commit` hook (or other npm script or terminal command) your resolution which looks like this:
+By running **Pastoralist** in a `pre-commit` hook (or other command) an override/resolution which looks like this:
 
 ```js
 // package.json
@@ -35,13 +37,17 @@ Will look like this:
 }
 ```
 
-By simply running a command similar to this!
+By running this!
 
-```js
-"pre-commit": "pastoralist"
+```sh
+pastoralist
+# oh hech yeah!
 ```
 
-But there's more! If `pastoralist` is run and a `resolution` or `override` is no longer required, it will clean up itself and resolutions!
+But there's more!
+
+If **Pastoralist** is run and a `resolution` or `override` is no longer required
+it will clean up itself and resolutions!
 
 ```js
 // pastoralist finds and removes `trim` when/if it's no longer needed!
@@ -49,7 +55,6 @@ But there's more! If `pastoralist` is run and a `resolution` or `override` is no
 "pastoralist": {
   "appendix": {}
 }
-
 ```
 
 ---
@@ -58,17 +63,19 @@ But there's more! If `pastoralist` is run and a `resolution` or `override` is no
 
 **Pastoralist** manages `overrides` and `resolutions` so you don't have to!
 
-Pastoralist is comprised of a few functions which read `node_module` `package.json` and reduce any `overrides` or `resolutions` within the root `package.json` into a single `appendix` object.
+**Pastoralist** is comprised of a few functions which read **node_modules** `package.json` files and reduce overrides or resolutions within the root `package.json` into a single `pastoralist.appendix` object.
 
-- Pastoralist adds an `appendix` with a list of "resolved" dependencies into a `pastoralist` key.
+- **Pastoralist** adds an `pastoralist.appendix` with a list of "resolved" dependencies.
 - Better yet, if Pastoralist observes an `override` or `resolution` is no longer needed, it removes it from `resolutions`, `overrides`, and the pastoralist `appendix` object.
-- This means with Pastoralist, your **only** concern is adding dependencies to the `overrides` and `resolutions` objects.
+- This means with **Pastoralist**, your **only** concern is adding dependencies to the `overrides` and `resolutions` objects.
 
 ### Key notes
 
-- Pastoralist does **not** manage what is added to overrides and resolutions objects.
-- Pastoralist **does** manage dependenceis that exists in a `package.json`'s overrides or resolutions objects.
-  - Pastoralist will remove overrides and resolutions if they become unneeded according to child `package.json`'s spec!
+- **Pastoralist** does **not** manage what is added to overrides and resolutions objects.
+- **Pastoralist does** manage dependenceis that exists in a `package.json`'s overrides or resolutions objects.
+  - **Pastoralist** will remove overrides and resolutions if they become unneeded according to child `package.json`'s spec!
+
+View the **[Pasture lifecycle doc](./docs/pasture-lifecycle.md)** to get some visuals into what Pastoralist has got going on!
 
 ---
 ## Install
@@ -82,19 +89,21 @@ npm install pastoralist --save-dev
 
 ## Usage
 
-Pastoralist is built to be used as a CLI program and runs with a single word "pastoralist".`
+**Pastoralist** is built to be used as a CLI program and runs with a single word "pastoralist".`
 
 ```sh
 pastoralist
 # => That's it! Chack out your package json
 ```
 
-Pastoralist can _and should be incorporated_ into your workflow—which ever way is best for you and your team's developer experience! 👌
+**Pastoralist** can _and should be incorporated_ into your workflow—which ever way is best for you and your team's developer experience! 👌
 
 ---
 ## Roadmap
 
-- [ ] More tests
-- [ ] Local development setup
-- [ ] Provide more configuration options using a tool like [cosmiconfig](https://github.com/davidtheclark/cosmiconfig).
-- [ ] Provide caveats, code examples, and more documentation.
+**Updated `2022-05-20`**
+
+- More tests (in progress)
+- Local development setup (next few days)
+- Provide more configuration options using a tool like [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) (within the next weeks)
+- Provide caveats, code examples, and more documentation (next few days)

package/dist/scripts.d.ts

@@ -2,5 +2,5 @@ import { Appendix, Options, OverridesType, PastoralistJSON, ResolveResolutionOpt
 export declare function resolveJSON(path: string, debug?: boolean): PastoralistJSON | void;
 export declare function resolveResolutions({ config: { overrides: npmOverrides, pnpm: { overrides: pnpmOverrides }, resolutions, }, options: { debug }, }: ResolveResolutionOptions): OverridesType;
 export declare function updateAppendix({ dependencies, resolutions, name, version, appendix, }: UpdateAppendixOptions): Appendix;
-export declare function updatePackageJSON({ appendix, path, config, resolutions, }: UpdatePackageJSONOptions): void;
+export declare function updatePackageJSON({ appendix, path, config, resolutions, isTesting, debug, }: UpdatePackageJSONOptions): PastoralistJSON | void;
 export declare function update(options: Options): Appendix | void;

package/dist/scripts.js

@@ -57,19 +57,31 @@ function updateAppendix(_a) {
 exports.updateAppendix = updateAppendix;
 function updatePackageJSON(_a) {
     var _b;
-    var appendix = _a.appendix, path = _a.path, config = _a.config, resolutions = _a.resolutions;
+    var appendix = _a.appendix, path = _a.path, config = _a.config, resolutions = _a.resolutions, _c = _a.isTesting, isTesting = _c === void 0 ? false : _c, _d = _a.debug, debug = _d === void 0 ? false : _d;
     var jsonPath = (0, path_1.resolve)(path);
     var pastoralist = (config === null || config === void 0 ? void 0 : config.pastoralist)
         ? tslib_1.__assign(tslib_1.__assign({}, config.pastoralist), { appendix: appendix }) : { appendix: appendix };
-    var json = tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, config), { pastoralist: pastoralist }), ((config === null || config === void 0 ? void 0 : config.resolutions)
+    var hasResolutions = resolutions && Object.keys(resolutions).length > 0;
+    var json = tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, config), { pastoralist: pastoralist }), ((config === null || config === void 0 ? void 0 : config.resolutions) && hasResolutions
         ? { resolutions: resolutions }
-        : (config === null || config === void 0 ? void 0 : config.overrides)
+        : (config === null || config === void 0 ? void 0 : config.overrides) && hasResolutions
             ? { overrides: resolutions }
-            : ((_b = config === null || config === void 0 ? void 0 : config.pnpm) === null || _b === void 0 ? void 0 : _b.overrides)
+            : ((_b = config === null || config === void 0 ? void 0 : config.pnpm) === null || _b === void 0 ? void 0 : _b.overrides) && hasResolutions
                 ? { pnpm: tslib_1.__assign(tslib_1.__assign({}, config.pnpm), { overrides: resolutions }) }
                 : {}));
+    if (debug)
+        console.log({
+            log: "🐑 👩🏽‍🌾 Pastoralist:updatePackageJSON:fn:",
+            json: json,
+            config: config,
+            pastoralist: pastoralist,
+            resolutions: resolutions,
+        });
+    if (isTesting)
+        return json;
     (0, fs_1.writeFile)(jsonPath, JSON.stringify(json, null, 2), function (err) {
-        return console.log("\uD83D\uDC11 \uD83D\uDC69\uD83C\uDFFD\u200D\uD83C\uDF3E Pastoralist had an issue updating overrides or resolutions in the package.json!".concat(err ? ", ".concat(err) : ""));
+        return debug &&
+            console.log("\uD83D\uDC11 \uD83D\uDC69\uD83C\uDFFD\u200D\uD83C\uDF3E Pastoralist had an issue updating overrides or resolutions in the package.json!\n".concat(err));
     });
 }
 exports.updatePackageJSON = updatePackageJSON;
@@ -96,8 +108,28 @@ function update(options) {
         return tslib_1.__assign(tslib_1.__assign({}, acc), appendixItem);
     }, {});
     var appendixItems = Object.keys(appendix);
-    var updatedResolutions = appendixItems.length > 0 &&
-        appendixItems.filter(function (item) { return Object.keys(appendix[item]).length > 0; });
+    var appendixItemsToBeRemoved = appendixItems.length > 0
+        ? appendixItems
+            .filter(function (item) { return Object.keys(appendix[item]).length > 0; })
+            .map(function (item) { return item.split("@")[0]; })
+        : [];
+    var updatedResolutions = appendixItemsToBeRemoved.length > 0
+        ? Object.keys(resolutions).reduce(function (acc, item) {
+            var _a;
+            var isItemToBeRemoved = appendixItemsToBeRemoved.includes(item);
+            if (isItemToBeRemoved)
+                return acc;
+            return tslib_1.__assign(tslib_1.__assign({}, acc), (_a = {}, _a[item] = resolutions[item], _a));
+        }, {})
+        : resolutions;
+    if (debug)
+        console.log({
+            log: "🐑 👩🏽‍🌾 Pastoralist:update:fn:",
+            appendix: appendix,
+            config: config,
+            path: path,
+            updatedResolutions: updatedResolutions,
+        });
     if (!isTesting) {
         updatePackageJSON({
             appendix: appendix,

package/dist/types.d.ts

@@ -40,7 +40,9 @@ export declare type Options = {
 export declare type OverridesType = Record<string, string>;
 export declare type UpdatePackageJSONOptions = {
     appendix?: Appendix;
+    debug?: boolean;
     path: string;
     config: PastoralistJSON;
-    resolutions?: false | string[];
+    resolutions?: OverridesType;
+    isTesting?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pastoralist",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "description": "A tool to watch over node module resolutions and overrides 🐑 👩🏽‍🌾",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,7 +13,15 @@
   "scripts": {
     "build": "npm run clean && npm run dist",
     "clean": "rm -rf dist",
+    "commit": "git-cz",
+    "commit-msg": "commitlint --edit $1",
     "dist": "tsc",
+    "husky-setup:commit-msg": "(path-exists .husky/commit-msg) || (npx husky add .husky/commit-msg 'npm run commit-msg')",
+    "husky-setup:post-merge": "(path-exists .husky/post-merge) || (npx husky add .husky/post-merge 'npm install && npm run build')",
+    "husky-setup:pre-commit": "(path-exists .husky/pre-commit) || (npx husky add .husky/pre-commit 'npm run pre-commit')",
+    "pre-commit": "lint-staged --quiet && npm run test",
+    "prepare": "is-ci || (husky install && npm run husky-setup:commit-msg --silent; npm run husky-setup:post-merge --silent; npm run husky-setup:pre-commit --silent)",
+    "prepublishOnly": "npm run test && npm run build",
     "test": "vitest run"
   },
   "repository": {
@@ -42,15 +50,36 @@
     "tslib": "^2.3.1"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.0.0",
+    "@commitlint/config-conventional": "^17.0.0",
     "@types/node": "^17.0.31",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.21.0",
     "eslint": "^8.10.0",
     "eslint-config-prettier": "^8.5.0",
+    "husky": "^8.0.1",
+    "is-ci": "^3.0.1",
+    "lint-staged": "^12.4.1",
+    "path-exists-cli": "^2.0.0",
     "release-it": "^15.0.0",
     "stdouttojson": "^0.3.1",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.4",
     "vitest": "^0.12.1"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "eslint --fix"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release v%s"
+    }
   }
 }