lerna-clean-changelogs 3.0.6 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/codsen/codsen/compare/lerna-clean-changelogs@3.0.11...lerna-clean-changelogs@4.0.0) (2022-01-22)
+
+### Bug Fixes
+
+- set options as a plain object ([814cf09](https://github.com/codsen/codsen/commit/814cf090d14c9810b2cf6074fad316fa43d125c8)), closes [#36](https://github.com/codsen/codsen/issues/36)
+
+### BREAKING CHANGES
+
+- from now, the options should be set as a plain object, ie. { extras: true }
+
 ## 3.0.0 (2021-09-09)
 
 ### Features

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2010-2021 Roy Revelt and other contributors
+Copyright (c) 2010-2022 Roy Revelt and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -26,18 +26,17 @@
 
 ## Install
 
-This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:
+The latest version is **ESM only**: Node 12+ is needed to use it and it must be `import`ed instead of `require`d. If your project is not on ESM yet and you want to use `require`, use an older version of this program, `2.1.0`.
 
 ```bash
 npm i lerna-clean-changelogs
 ```
 
-If you need a legacy version which works with `require`, use version 2.1.0
-
 ## Quick Take
 
 ```js
 import { strict as assert } from "assert";
+
 import { cleanChangelogs } from "lerna-clean-changelogs";
 
 // are all values equal to null:
@@ -49,16 +48,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## 2.9.2 (2018-12-27)
 
-
-
-
-
-
-
 **Note:** Version bump only for package ranges-apply
 
-
-
 ## [2.9.1](https://gitlab.com/codsen/codsen/tree/master/packages/ranges-apply/compare/ranges-apply@2.9.0...ranges-apply@2.9.1) (2018-12-27)
 
 **Note:** Version bump only for package ranges-apply
@@ -98,7 +89,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## Documentation
 
-Please [visit codsen.com](https://codsen.com/os/lerna-clean-changelogs/) for a full description of the API and examples.
+Please [visit codsen.com](https://codsen.com/os/lerna-clean-changelogs/) for a full description of the API.
 
 ## Contributing
 
@@ -108,6 +99,6 @@ To report bugs or request features or assistance, [raise an issue](https://githu
 
 MIT License
 
-Copyright (c) 2010-2021 Roy Revelt and other contributors
+Copyright (c) 2010-2022 Roy Revelt and other contributors
 
 <img src="https://codsen.com/images/png-codsen-ok.png" width="98" alt="ok" align="center"> <img src="https://codsen.com/images/png-codsen-1.png" width="148" alt="codsen" align="center"> <img src="https://codsen.com/images/png-codsen-star-small.png" width="32" alt="star" align="center">

package/dist/lerna-clean-changelogs.esm.js

@@ -1,88 +1,15 @@
 /**
  * @name lerna-clean-changelogs
  * @fileoverview Removes frivolous entries from commitizen generated changelogs
- * @version 3.0.6
+ * @version 4.0.0
  * @author Roy Revelt, Codsen Ltd
  * @license MIT
  * {@link https://codsen.com/os/lerna-clean-changelogs/}
  */
 
-var version$1 = "3.0.6";
-
-const version = version$1;
-function isStr(something) {
-    return typeof something === "string";
-}
-function cleanChangelogs(changelogContents, extras = false) {
-    if (changelogContents === undefined) {
-        throw new Error(`lerna-clean-changelogs: [THROW_ID_01] The first input argument is missing!`);
-    }
-    else if (!isStr(changelogContents)) {
-        throw new Error(`lerna-clean-changelogs: [THROW_ID_02] The first input argument must be a string! It was given as ${Array.isArray(changelogContents) ? "array" : typeof changelogContents}, equal to:\n${JSON.stringify(changelogContents, null, 4)}`);
-    }
-    let final;
-    let lastLineWasEmpty = false;
-    if (typeof changelogContents === "string" &&
-        changelogContents.length &&
-        (!changelogContents.includes("\n") || !changelogContents.includes("\r"))) {
-        /* istanbul ignore next */
-        const changelogEndedWithLinebreak = isStr(changelogContents) &&
-            changelogContents.length &&
-            (changelogContents[changelogContents.length - 1] === "\n" ||
-                changelogContents[changelogContents.length - 1] === "\r");
-        changelogContents = changelogContents
-            .trim()
-            .replace(/(https:\/\/git\.sr\.ht\/~[^/]+\/[^/]+\/)commits\//g, "$1commit/");
-        const linesArr = changelogContents.split(/\r?\n/);
-        if (extras) {
-            linesArr.forEach((line, i) => {
-                if (line.startsWith("#")) {
-                    linesArr[i] = line.replace(/(#+) \[?(\d+\.\d+\.\d+)\s?\]\([^)]*\)/g, "$1 $2");
-                }
-                if (i && linesArr[i].startsWith("# ")) {
-                    linesArr[i] = `#${linesArr[i]}`;
-                }
-            });
-        }
-        const newLinesArr = [];
-        for (let i = linesArr.length; i--;) {
-            if (linesArr[i].startsWith("**Note:** Version bump only") ||
-                (extras && linesArr[i].toLowerCase().includes("wip"))) {
-                while (isStr(linesArr[i - 1]) && !linesArr[i - 1].trim() && i) {
-                    i -= 1;
-                }
-                if (i &&
-                    isStr(linesArr[i - 1]) &&
-                    linesArr[i - 1].trim().startsWith("#")) {
-                    i -= 1;
-                }
-                while (isStr(linesArr[i - 1]) && !linesArr[i - 1].trim() && i) {
-                    i -= 1;
-                }
-            }
-            else if (!linesArr[i].trim()) {
-                if (!lastLineWasEmpty) {
-                    newLinesArr.unshift(linesArr[i].trim());
-                    lastLineWasEmpty = true;
-                }
-            }
-            else if (linesArr[i][0] === "*" && linesArr[i][1] === " ") {
-                newLinesArr.unshift(`- ${linesArr[i].slice(2)}`);
-            }
-            else {
-                newLinesArr.unshift(linesArr[i]);
-            }
-            if (linesArr[i].trim()) {
-                lastLineWasEmpty = false;
-            }
-        }
-        /* istanbul ignore next */
-        final = `${newLinesArr.join("\n")}${changelogEndedWithLinebreak ? "\n" : ""}`;
-    }
-    return {
-        version,
-        res: final || changelogContents,
-    };
-}
-
-export { cleanChangelogs, version };
+var u="4.0.0";var d=u;function i(r){return typeof r=="string"}var f={extras:!1};function $(r,p){if(r===void 0)throw new Error("lerna-clean-changelogs: [THROW_ID_01] The first input argument is missing!");if(!i(r))throw new Error(`lerna-clean-changelogs: [THROW_ID_02] The first input argument must be a string! It was given as ${Array.isArray(r)?"array":typeof r}, equal to:
+${JSON.stringify(r,null,4)}`);let a={...f,...p},o,l=!1;if(typeof r=="string"&&r.length&&(!r.includes(`
+`)||!r.includes("\r"))){let c=i(r)&&r.length&&(r[r.length-1]===`
+`||r[r.length-1]==="\r");r=r.trim().replace(/(https:\/\/git\.sr\.ht\/~[^/]+\/[^/]+\/)commits\//g,"$1commit/");let t=r.split(/\r?\n/);a.extras&&t.forEach((e,s)=>{e.startsWith("#")&&(t[s]=e.replace(/(#+) \[?(\d+\.\d+\.\d+)\s?\]\([^)]*\)/g,"$1 $2")),s&&t[s].startsWith("# ")&&(t[s]=`#${t[s]}`)});let n=[];for(let e=t.length;e--;){if(t[e].startsWith("**Note:** Version bump only")||a.extras&&t[e].toLowerCase().includes("wip")){for(;i(t[e-1])&&!t[e-1].trim()&&e;)e-=1;for(e&&i(t[e-1])&&t[e-1].trim().startsWith("#")&&(e-=1);i(t[e-1])&&!t[e-1].trim()&&e;)e-=1}else t[e].trim()?t[e][0]==="*"&&t[e][1]===" "?n.unshift(`- ${t[e].slice(2)}`):n.unshift(t[e]):l||(n.unshift(t[e].trim()),l=!0);t[e].trim()&&(l=!1)}o=`${n.join(`
+`)}${c?`
+`:""}`}return{version:d,res:o||r}}export{$ as cleanChangelogs,d as version};

package/dist/lerna-clean-changelogs.umd.js

@@ -1,10 +1,15 @@
 /**
  * @name lerna-clean-changelogs
  * @fileoverview Removes frivolous entries from commitizen generated changelogs
- * @version 3.0.6
+ * @version 4.0.0
  * @author Roy Revelt, Codsen Ltd
  * @license MIT
  * {@link https://codsen.com/os/lerna-clean-changelogs/}
  */
 
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self).lernaCleanChangelogs={})}(this,(function(t){"use strict";const e="3.0.6";function n(t){return"string"==typeof t}t.cleanChangelogs=function(t,r=!1){if(void 0===t)throw new Error("lerna-clean-changelogs: [THROW_ID_01] The first input argument is missing!");if(!n(t))throw new Error(`lerna-clean-changelogs: [THROW_ID_02] The first input argument must be a string! It was given as ${Array.isArray(t)?"array":typeof t}, equal to:\n${JSON.stringify(t,null,4)}`);let i,s=!1;if("string"==typeof t&&t.length&&(!t.includes("\n")||!t.includes("\r"))){const e=n(t)&&t.length&&("\n"===t[t.length-1]||"\r"===t[t.length-1]),o=(t=t.trim().replace(/(https:\/\/git\.sr\.ht\/~[^/]+\/[^/]+\/)commits\//g,"$1commit/")).split(/\r?\n/);r&&o.forEach(((t,e)=>{t.startsWith("#")&&(o[e]=t.replace(/(#+) \[?(\d+\.\d+\.\d+)\s?\]\([^)]*\)/g,"$1 $2")),e&&o[e].startsWith("# ")&&(o[e]=`#${o[e]}`)}));const l=[];for(let t=o.length;t--;){if(o[t].startsWith("**Note:** Version bump only")||r&&o[t].toLowerCase().includes("wip")){for(;n(o[t-1])&&!o[t-1].trim()&&t;)t-=1;for(t&&n(o[t-1])&&o[t-1].trim().startsWith("#")&&(t-=1);n(o[t-1])&&!o[t-1].trim()&&t;)t-=1}else o[t].trim()?l.unshift("*"===o[t][0]&&" "===o[t][1]?`- ${o[t].slice(2)}`:o[t]):s||(l.unshift(o[t].trim()),s=!0);o[t].trim()&&(s=!1)}i=`${l.join("\n")}${e?"\n":""}`}return{version:e,res:i||t}},t.version=e,Object.defineProperty(t,"__esModule",{value:!0})}));
+var lernaCleanChangelogs=(()=>{var p=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames,m=Object.getOwnPropertySymbols;var d=Object.prototype.hasOwnProperty,E=Object.prototype.propertyIsEnumerable;var f=(e,r,s)=>r in e?p(e,r,{enumerable:!0,configurable:!0,writable:!0,value:s}):e[r]=s,c=(e,r)=>{for(var s in r||(r={}))d.call(r,s)&&f(e,s,r[s]);if(m)for(var s of m(r))E.call(r,s)&&f(e,s,r[s]);return e};var x=e=>p(e,"__esModule",{value:!0});var v=(e,r)=>{for(var s in r)p(e,s,{get:r[s],enumerable:!0})},w=(e,r,s,l)=>{if(r&&typeof r=="object"||typeof r=="function")for(let n of b(r))!d.call(e,n)&&(s||n!=="default")&&p(e,n,{get:()=>r[n],enumerable:!(l=g(r,n))||l.enumerable});return e};var W=(e=>(r,s)=>e&&e.get(r)||(s=w(x({}),r,1),e&&e.set(r,s),s))(typeof WeakMap!="undefined"?new WeakMap:0);var O={};v(O,{cleanChangelogs:()=>L,version:()=>h});var y="4.0.0";var h=y;function o(e){return typeof e=="string"}var D={extras:!1};function L(e,r){if(e===void 0)throw new Error("lerna-clean-changelogs: [THROW_ID_01] The first input argument is missing!");if(!o(e))throw new Error(`lerna-clean-changelogs: [THROW_ID_02] The first input argument must be a string! It was given as ${Array.isArray(e)?"array":typeof e}, equal to:
+${JSON.stringify(e,null,4)}`);let s=c(c({},D),r),l,n=!1;if(typeof e=="string"&&e.length&&(!e.includes(`
+`)||!e.includes("\r"))){let $=o(e)&&e.length&&(e[e.length-1]===`
+`||e[e.length-1]==="\r");e=e.trim().replace(/(https:\/\/git\.sr\.ht\/~[^/]+\/[^/]+\/)commits\//g,"$1commit/");let i=e.split(/\r?\n/);s.extras&&i.forEach((t,a)=>{t.startsWith("#")&&(i[a]=t.replace(/(#+) \[?(\d+\.\d+\.\d+)\s?\]\([^)]*\)/g,"$1 $2")),a&&i[a].startsWith("# ")&&(i[a]=`#${i[a]}`)});let u=[];for(let t=i.length;t--;){if(i[t].startsWith("**Note:** Version bump only")||s.extras&&i[t].toLowerCase().includes("wip")){for(;o(i[t-1])&&!i[t-1].trim()&&t;)t-=1;for(t&&o(i[t-1])&&i[t-1].trim().startsWith("#")&&(t-=1);o(i[t-1])&&!i[t-1].trim()&&t;)t-=1}else i[t].trim()?i[t][0]==="*"&&i[t][1]===" "?u.unshift(`- ${i[t].slice(2)}`):u.unshift(i[t]):n||(u.unshift(i[t].trim()),n=!0);i[t].trim()&&(n=!1)}l=`${u.join(`
+`)}${$?`
+`:""}`}return{version:h,res:l||e}}return W(O);})();

package/examples/_quickTake.js

@@ -1,6 +1,7 @@
 // Quick Take
 
 import { strict as assert } from "assert";
+
 import { cleanChangelogs } from "../dist/lerna-clean-changelogs.esm.js";
 
 // are all values equal to null:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lerna-clean-changelogs",
-  "version": "3.0.6",
+  "version": "4.0.0",
   "description": "Removes frivolous entries from commitizen generated changelogs",
   "keywords": [
     "changelog",
@@ -35,89 +35,37 @@
   },
   "types": "types/index.d.ts",
   "scripts": {
-    "build": "rollup -c",
-    "build:esbuild": "node '../../scripts/esbuild.js'",
-    "build:esbuild:dev": "cross-env MODE=dev node '../../scripts/esbuild.js'",
-    "ci_test": "npm run build && npm run format && tap --no-only --reporter=silent",
-    "clean_types": "../../scripts/cleanTypes.js",
-    "dev": "rollup -c --dev",
-    "devunittest": "npm run dev && tap --only -R 'base'",
-    "format": "npm run lect && npm run prettier && npm run lint",
-    "lect": "lect",
-    "lint": "../../node_modules/eslint/bin/eslint.js . --ext .js --ext .ts --fix --config \"../../.eslintrc.json\" --quiet",
-    "perf": "node perf/check",
-    "prettier": "../../node_modules/prettier/bin-prettier.js '*.{js,css,scss,vue,md,ts}' --write --loglevel silent",
-    "republish": "npm publish || :",
-    "tap": "tap",
-    "pretest": "npm run build",
-    "test": "npm run test:ci && npm run perf",
-    "test:ci": "npm run unittest && npm run test:examples && npm run format",
-    "test:examples": "../../scripts/test-examples.js && npm run lect && npm run prettier",
-    "tsc": "tsc",
-    "unittest": "tap --no-only --reporter=terse && tsc -p tsconfig.json --noEmit"
+    "build": "node '../../ops/scripts/esbuild.js' && yarn run dts",
+    "dev": "DEV=true node '../../ops/scripts/esbuild.js' && yarn run dts",
+    "devtest": "c8 yarn run unit && yarn run examples && yarn run lint",
+    "dts": "rollup -c && yarn run prettier 'types/index.d.ts' --write",
+    "examples": "node '../../ops/scripts/run-examples.js'",
+    "lect": "node '../../ops/lect/lect.js' && yarn run prettier 'README.md' '.all-contributorsrc' 'rollup.config.js' --write",
+    "letspublish": "yarn publish || :",
+    "lint": "eslint . --fix",
+    "perf": "node perf/check.js",
+    "prepare": "echo 'ready'",
+    "prettier": "prettier",
+    "prettier:format": "prettier --write '**/*.{ts,tsx,md}' --no-error-on-unmatched-pattern",
+    "pretest": "yarn run lect && yarn run build",
+    "test": "yarn run devtest",
+    "unit": "uvu test"
   },
-  "tap": {
-    "check-coverage": false,
-    "node-arg": [
-      "--no-warnings",
-      "--experimental-loader",
-      "@istanbuljs/esm-loader-hook"
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "c8": {
+    "check-coverage": true,
+    "exclude": [
+      "**/test/**/*.*"
     ],
-    "timeout": 0
+    "lines": 100
   },
   "lect": {
     "licence": {
       "extras": [
         ""
       ]
-    },
-    "req": "{ cleanChangelogs }",
-    "various": {
-      "devDependencies": []
     }
-  },
-  "dependencies": {
-    "@babel/runtime": "^7.16.3"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.16.0",
-    "@babel/node": "^7.16.0",
-    "@babel/plugin-external-helpers": "^7.16.0",
-    "@babel/plugin-proposal-class-properties": "^7.16.0",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.0",
-    "@babel/plugin-proposal-object-rest-spread": "^7.16.0",
-    "@babel/plugin-proposal-optional-chaining": "^7.16.0",
-    "@babel/plugin-transform-runtime": "^7.16.4",
-    "@babel/preset-env": "^7.16.4",
-    "@babel/preset-typescript": "^7.16.0",
-    "@babel/register": "^7.16.0",
-    "@istanbuljs/esm-loader-hook": "^0.1.2",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.0.6",
-    "@rollup/plugin-strip": "^2.1.0",
-    "@rollup/plugin-typescript": "^8.3.0",
-    "@types/node": "^16.11.9",
-    "@types/tap": "^15.0.5",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
-    "core-js": "^3.19.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.3.0",
-    "lect": "^0.18.6",
-    "rollup": "^2.60.0",
-    "rollup-plugin-ascii": "^0.0.3",
-    "rollup-plugin-banner": "^0.2.1",
-    "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-dts": "^4.0.1",
-    "rollup-plugin-terser": "^7.0.2",
-    "tap": "^15.1.2",
-    "tslib": "^2.3.1",
-    "typescript": "^4.5.2"
-  },
-  "engines": {
-    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   }
 }

package/types/index.d.ts

@@ -1,7 +1,13 @@
 declare const version: string;
-declare function cleanChangelogs(changelogContents: string, extras?: boolean): {
-    version: string;
-    res: string;
+interface Opts {
+  extras: boolean;
+}
+declare function cleanChangelogs(
+  changelogContents: string,
+  originalOpts?: Partial<Opts>
+): {
+  version: string;
+  res: string;
 };
 
 export { cleanChangelogs, version };

package/examples/api.json

@@ -1 +0,0 @@
-{"_quickTake.js":{"title":"Quick Take","content":"import { strict as assert } from \"assert\";\nimport { cleanChangelogs } from \"lerna-clean-changelogs\";\n\n// are all values equal to null:\nassert.equal(\n  cleanChangelogs(`# Change Log\n\nAll notable changes to this project will be documented in this file.\nSee [Conventional Commits](https://conventionalcommits.org) for commit guidelines.\n\n## 2.9.2 (2018-12-27)\n\n\n\n\n\n\n\n**Note:** Version bump only for package ranges-apply\n\n\n\n## [2.9.1](https://gitlab.com/codsen/codsen/tree/master/packages/ranges-apply/compare/ranges-apply@2.9.0...ranges-apply@2.9.1) (2018-12-27)\n\n**Note:** Version bump only for package ranges-apply\n\n## 2.9.0 (2018-12-26)\n\n### Bug Fixes\n\n* aaa\n\n### Features\n\n* bbb\n\n`).res,\n  //\n  //\n  //\n  // output:\n  `# Change Log\n\nAll notable changes to this project will be documented in this file.\nSee [Conventional Commits](https://conventionalcommits.org) for commit guidelines.\n\n## 2.9.0 (2018-12-26)\n\n### Bug Fixes\n\n- aaa\n\n### Features\n\n- bbb\n`\n);"}}