@myparcel-dev/semantic-release-wordpress-readme-generator 1.3.0

package/README.md

@@ -0,0 +1,76 @@
+# semantic-release-wordpress-readme-generator
+
+Generates a readme.txt for WordPress plugin releases.
+
+## Installation
+
+### With Yarn
+
+```shell
+yarn add -D @myparcel-dev/semantic-release-wordpress-readme-generator
+```
+
+### With PNPM
+
+```shell
+pnpm add -D @myparcel-dev/semantic-release-wordpress-readme-generator
+```
+
+### With NPM
+
+```shell
+npm install --save-dev @myparcel-dev/semantic-release-wordpress-readme-generator
+```
+
+## Usage
+
+Add the following to your `release.config.js`, below the `@semantic-release/changelog` plugin:
+
+```js
+const wordpressReadme = require('@myparcel-dev/semantic-release-wordpress-readme-generator');
+
+module.exports = {
+  plugins: [
+    // ...
+    '@myparcel-dev/semantic-release-wordpress-readme-generator',
+  ],
+};
+```
+
+### Options
+
+By default, this is the configuration that will be used. This defines which commits will be included in the readme, and the order in which the entries will be written.
+
+| Type     | Prefix                      |
+|----------|-----------------------------|
+| `feat`   | `New: `                     |
+| `fix`    | `Fixed bug: `               |
+| `perf`   | `Performance improvement: ` |
+| `revert` | `Reverted: `                |
+
+To customize this, pass an object to the plugin and override the `types` property:
+
+```js
+const wordpressReadme = require('@myparcel-dev/semantic-release-wordpress-readme-generator');
+
+module.exports = {
+  plugins: [
+    // ...
+    [
+      '@myparcel-dev/semantic-release-wordpress-readme-generator',
+      {
+        types: [
+          {
+            type: 'feat',
+            prefix: 'Feature: ',
+          },
+          {
+            type: 'fix',
+            prefix: 'Fix: ',
+          },
+        ]
+      }
+    ],
+  ],
+};
+```

package/lib/semantic-release-wordpress-readme-generator.mjs

@@ -0,0 +1,44 @@
+const d = require("fs"), a = require("debug")("semantic-release:@myparcel/semantic-release-wordpress-readme-generator"), v = [
+  {
+    type: "feat",
+    prefix: "New: "
+  },
+  {
+    type: "fix",
+    prefix: "Fixed bug: "
+  },
+  {
+    type: "perf",
+    prefix: "Performance improvement: "
+  },
+  {
+    type: "revert",
+    prefix: "Revert: "
+  }
+], A = {
+  generateNotes(u, m) {
+    const { commits: f, nextRelease: o, cwd: y, logger: x } = m, c = `${y}/readme.txt`, $ = (/* @__PURE__ */ new Date()).toISOString().substring(0, 10);
+    let { types: n } = u;
+    (!n || !Array.isArray(n) || n.length === 0) && (n = v);
+    const s = n.map((e) => e.type), b = f.reduce((e, t) => {
+      var l;
+      a(`Parsing ${t.subject}`);
+      const r = t.subject.split(":")[0], i = r == null ? void 0 : r.replace(/!|\(.+\)/, "").trim();
+      if (!s.includes(i))
+        return a(`Skipping commit: ${t.subject}`), e;
+      const { prefix: p } = n.find((h) => h.type === i), g = (l = t.subject.split(":")[1]) == null ? void 0 : l.trim();
+      return e.push({
+        type: i,
+        message: `* ${p}${g}`
+      }), a(`Adding commit: ${t.subject} – * ${p}${g}`), e;
+    }, []).sort((e, t) => s.indexOf(e.type) - s.indexOf(t.type)), S = `= ${o.version} (${$}) =
+
+${b.map((e) => e.message).join(`
+`)}`, j = d.readFileSync(c).toString("utf-8").replace("== Changelog ==", `== Changelog ==
+
+${S}`).replace(/Stable tag: .+\nRequires/g, `Stable tag: ${o.version}
+Requires`);
+    d.writeFileSync(c, j), x.log("Updated changelog in readme.txt");
+  }
+};
+module.exports = A;

package/lib/semantic-release-wordpress-readme-generator.umd.js

@@ -0,0 +1,7 @@
+(function(s){typeof define=="function"&&define.amd?define(s):s()})(function(){"use strict";const s=require("fs"),r=require("debug")("semantic-release:@myparcel/semantic-release-wordpress-readme-generator"),l=[{type:"feat",prefix:"New: "},{type:"fix",prefix:"Fixed bug: "},{type:"perf",prefix:"Performance improvement: "},{type:"revert",prefix:"Revert: "}],f={generateNotes(m,y){const{commits:x,nextRelease:a,cwd:$,logger:b}=y,p=`${$}/readme.txt`,S=new Date().toISOString().substring(0,10);let{types:n}=m;(!n||!Array.isArray(n)||n.length===0)&&(n=l);const i=n.map(e=>e.type),j=x.reduce((e,t)=>{var u;r(`Parsing ${t.subject}`);const o=t.subject.split(":")[0],c=o==null?void 0:o.replace(/!|\(.+\)/,"").trim();if(!i.includes(c))return r(`Skipping commit: ${t.subject}`),e;const{prefix:g}=n.find(A=>A.type===c),d=(u=t.subject.split(":")[1])==null?void 0:u.trim();return e.push({type:c,message:`* ${g}${d}`}),r(`Adding commit: ${t.subject} – * ${g}${d}`),e},[]).sort((e,t)=>i.indexOf(e.type)-i.indexOf(t.type)),h=`= ${a.version} (${S}) =
+
+${j.map(e=>e.message).join(`
+`)}`,v=s.readFileSync(p).toString("utf-8").replace("== Changelog ==",`== Changelog ==
+
+${h}`).replace(/Stable tag: .+\nRequires/g,`Stable tag: ${a.version}
+Requires`);s.writeFileSync(p,v),b.log("Updated changelog in readme.txt")}};module.exports=f});

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@myparcel-dev/semantic-release-wordpress-readme-generator",
+  "version": "1.3.0",
+  "description": "Generates a readme.txt for use with WordPress plugin releases in semantic-release",
+  "repository": {
+    "type": "git",
+    "url": "github:myparcelnl/semantic-release-wordpress-readme-generator"
+  },
+  "license": "MIT",
+  "author": "MyParcel <support@myparcel.nl>",
+  "main": "./lib/semantic-release-wordpress-readme-generator.umd.js",
+  "module": "./lib/semantic-release-wordpress-readme-generator.mjs",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "prepare": "is-ci || husky install",
+    "build": "vite build"
+  },
+  "lint-staged": {
+    "package.json": "npx sort-package-json",
+    "*.js": "npx eslint --fix"
+  },
+  "prettier": "@myparcel-dev/prettier-config",
+  "release": {
+    "extends": "@myparcel-dev/semantic-release-config/github-npm"
+  },
+  "dependencies": {
+    "debug": "^4.0.0"
+  },
+  "devDependencies": {
+    "@myparcel-dev/semantic-release-config": "^6.0.0",
+    "@myparcel-eslint/eslint-config-esnext": "^1.2.0",
+    "@myparcel-eslint/eslint-config-node": "^1.2.0",
+    "@myparcel-eslint/eslint-config-prettier": "^1.2.0",
+    "eslint": "^8.38.0",
+    "husky": "^8.0.1",
+    "is-ci": "^3.0.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "semantic-release": "^21.0.0",
+    "vite": "^4.0.0"
+  },
+  "peerDependencies": {
+    "semantic-release": "^19 || ^20 || ^21"
+  },
+  "packageManager": "yarn@3.5.0",
+  "publishConfig": {
+    "access": "public"
+  }
+}