@sanity/plugin-kit 1.1.0-ecosystem-preset.8 → 1.1.0-ecosystem-preset.9

package/assets/inject/semver-workflow/npmrc

@@ -0,0 +1 @@
+legacy-peer-deps=true

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sanity/plugin-kit",
-    "version": "1.1.0-ecosystem-preset.8",
+    "version": "1.1.0-ecosystem-preset.9",
     "description": "Enhanced Sanity.io plugin development experience",
     "scripts": {
         "clean": "rimraf lib",

package/lib/src/presets/semver-workflow.d.ts

@@ -1,4 +1,8 @@
 import { Preset } from './presets';
 import { PackageJson } from '../actions/verify/types';
 export declare const semverWorkflowPreset: Preset;
+/**
+ * Returns sections that does not exists "close enough" in readme
+ */
+export declare function missingSections(readme: string, sections: string[]): string[];
 export declare function readmeBaseurl(pkg: PackageJson): string;

package/lib/src/presets/semver-workflow.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readmeBaseurl = exports.semverWorkflowPreset = void 0;
+exports.readmeBaseurl = exports.missingSections = exports.semverWorkflowPreset = void 0;
 const inject_1 = require("../actions/inject");
 const resolveLatestVersions_1 = require("../npm/resolveLatestVersions");
 const package_1 = require("../npm/package");
@@ -69,10 +69,16 @@ function updateReadme(options) {
         const { basePath } = options;
         const readmePath = path_1.default.join(basePath, 'README.md');
         const readme = (_a = (yield (0, files_1.readFile)(readmePath, 'utf8').catch(errorToUndefined_1.errorToUndefined))) !== null && _a !== void 0 ? _a : '';
-        const { v3Banner, installUsage, developFooter } = yield readmeSnippets(options);
-        const updatedReadme = [v3Banner, installUsage, readme, developFooter].filter(Boolean).join('\n\n');
-        yield (0, files_1.writeFile)(readmePath, updatedReadme, { encoding: 'utf8' });
-        log_1.default.info('Updated README. Please review the changes.');
+        const { v3Banner, install, usage, developFooter } = yield readmeSnippets(options);
+        const prependSections = missingSections(readme, [v3Banner, install, usage]);
+        const appendSections = missingSections(readme, [developFooter]);
+        if (prependSections.length || appendSections.length) {
+            const updatedReadme = [...prependSections, readme, ...appendSections]
+                .filter(Boolean)
+                .join('\n\n');
+            yield (0, files_1.writeFile)(readmePath, updatedReadme, { encoding: 'utf8' });
+            log_1.default.info('Updated README. Please review the changes.');
+        }
     });
 }
 function readmeSnippets(options) {
@@ -86,7 +92,7 @@ function readmeSnippets(options) {
     >
     > For the v2 version, please refer to the [v2-branch](${bestEffortUrl}).
   `;
-        const installUsage = (0, outdent_1.default) `
+        const install = (0, outdent_1.default) `
     ## Installation
 
     \`\`\`
@@ -98,10 +104,9 @@ function readmeSnippets(options) {
     \`\`\`
     yarn add ${pkg.name}@studio-v3
     \`\`\`
-
+  `;
+        const usage = (0, outdent_1.default) `
     ## Usage
-
-    <TODO: Show usage here>
   `;
         const developFooter = (0, outdent_1.default) `
     ## License
@@ -125,18 +130,38 @@ function readmeSnippets(options) {
   `;
         return {
             v3Banner,
-            installUsage,
+            install,
+            usage,
             developFooter,
         };
     });
 }
+/**
+ * Returns sections that does not exists "close enough" in readme
+ */
+function missingSections(readme, sections) {
+    return sections.filter((section) => !closeEnough(section, readme));
+}
+exports.missingSections = missingSections;
+/**
+ * a and b are considered "close enough" if > 50% of a lines exist in b lines
+ * @param a
+ * @param b
+ */
+function closeEnough(a, b) {
+    const aLines = a.split('\n');
+    const bLines = b.split('\n');
+    const matchingLines = aLines.filter((line) => bLines.find((bLine) => bLine === line)).length;
+    const isCloseEnough = matchingLines > aLines.length * 0.5;
+    return isCloseEnough;
+}
 function semverWorkflowFiles() {
     return [
         { from: ['.github', 'workflows', 'main.yml'], to: ['.github', 'workflows', 'main.yml'] },
         { from: ['.husky', 'commit-msg'], to: ['.husky', 'commit-msg'] },
         { from: ['.husky', 'pre-commit'], to: ['.husky', 'pre-commit'] },
         { from: ['.releaserc.json'], to: '.releaserc.json' },
-        { from: ['.npmrc'], to: '.npmrc' },
+        { from: ['npmrc'], to: '.npmrc' },
         { from: ['commitlint.template.js'], to: 'commitlint.config.js' },
         { from: ['lint-staged.template.js'], to: 'lint-staged.config.js' },
     ].map((fromTo) => (Object.assign(Object.assign({}, fromTo), { from: ['semver-workflow', ...fromTo.from] })));

package/lib/src/presets/semver-workflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"semver-workflow.js","sourceRoot":"","sources":["../../../src/presets/semver-workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAAoE;AACpE,wEAAkE;AAElE,4CAMuB;AACvB,sDAA6B;AAC7B,sDAA6B;AAC7B,kDAAyB;AACzB,gDAAuB;AACvB,yCAAiD;AACjD,+DAAyD;AAG5C,QAAA,oBAAoB,GAAW;IAC1C,IAAI,EAAE,iBAAiB;IACvB,WAAW,EACT,wFAAwF;IAC1F,KAAK,EAAE,WAAW;CACnB,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,KAAK,IAAI,aAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;AAEhG,SAAe,WAAW,CAAC,OAAsB;;QAC/C,MAAM,IAAA,oBAAW,EAAC,mBAAmB,EAAE,EAAE,OAAO,CAAC,CAAA;QACjD,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC/B,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACjC,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;CAAA;AAED,SAAe,gBAAgB,CAAC,OAAsB;;QACpD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAqB,EAAC,GAAG,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACrE,OAAO,CAAC,OAAO,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;YAC7D,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAA;IACxD,CAAC;CAAA;AAED,SAAe,kBAAkB,CAAC,OAAsB;;QACtD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAA,kBAAQ,kCACnB,GAAG,CAAC,eAAe,GACnB,CAAC,MAAM,0BAA0B,EAAE,CAAC,EACvC,CAAA;QACF,MAAM,MAAM,qBAAO,GAAG,CAAC,CAAA;QACvB,MAAM,CAAC,eAAe,GAAG,OAAO,CAAA;QAChC,MAAM,IAAA,gCAAsB,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7C,aAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;QAEpC,aAAG,CAAC,IAAI,CACN,eAAK,CAAC,KAAK,CACT,IAAA,iBAAO,EAAA;;;;;;GAMV,CAAC,IAAI,EAAE,CACL,CACF,CAAA;IACH,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,OAAsB;;;QAChD,MAAM,EAAC,QAAQ,EAAC,GAAG,OAAO,CAAA;QAE1B,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAA,CAAC,MAAM,IAAA,gBAAQ,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,mCAAgB,CAAC,CAAC,mCAAI,EAAE,CAAA;QAEjF,MAAM,EAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAC,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAA;QAC7E,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClG,MAAM,IAAA,iBAAS,EAAC,UAAU,EAAE,aAAa,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;QAC9D,aAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAA;;CACvD;AAED,SAAe,cAAc,CAAC,OAAsB;;QAClD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QAErC,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;QAExC,MAAM,QAAQ,GAAG,IAAA,iBAAO,EAAA;;;oDAG0B,GAAG,CAAC,IAAI;;4DAEA,aAAa;GACtE,CAAA;QAED,MAAM,YAAY,GAAG,IAAA,iBAAO,EAAA;;;;yBAIL,GAAG,CAAC,IAAI;;;;;;eAMlB,GAAG,CAAC,IAAI;;;;;;GAMpB,CAAA;QAED,MAAM,aAAa,GAAG,IAAA,iBAAO,EAAA;;;;;;;;;;;;;;;oCAeK,aAAa;;;;GAI9C,CAAA;QAED,OAAO;YACL,QAAQ;YACR,YAAY;YACZ,aAAa;SACd,CAAA;IACH,CAAC;CAAA;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,EAAC,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAC;QACtF,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,iBAAiB,EAAC;QAClD,EAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAC;QAChC,EAAC,IAAI,EAAE,CAAC,wBAAwB,CAAC,EAAE,EAAE,EAAE,sBAAsB,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,EAAE,EAAE,EAAE,uBAAuB,EAAC;KACjE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACb,MAAM,KACT,IAAI,EAAE,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IACzC,CAAC,CAAA;AACL,CAAC;AAED,SAAe,0BAA0B;;QACvC,OAAO,IAAA,6CAAqB,EAAC;YAC3B,iBAAiB;YACjB,iCAAiC;YACjC,iCAAiC;YACjC,OAAO;YACP,aAAa;SACd,CAAC,CAAA;IACJ,CAAC;CAAA;AAED,SAAgB,aAAa,CAAC,GAAgB;;IAC5C,OAAQ,CAAC,MAAA,MAAA,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,mCAAI,GAAG,CAAC,QAAQ,mCAAI,MAAM,CAAY;SAC/D,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC;SAClC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;SACxB,UAAU,CAAC,mBAAmB,EAAE,aAAa,CAAC;SAC9C,UAAU,CAAC,kBAAkB,EAAE,qBAAqB,CAAC;SACrD,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAC3B,CAAC;AAPD,sCAOC"}
+{"version":3,"file":"semver-workflow.js","sourceRoot":"","sources":["../../../src/presets/semver-workflow.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAAoE;AACpE,wEAAkE;AAElE,4CAMuB;AACvB,sDAA6B;AAC7B,sDAA6B;AAC7B,kDAAyB;AACzB,gDAAuB;AACvB,yCAAiD;AACjD,+DAAyD;AAG5C,QAAA,oBAAoB,GAAW;IAC1C,IAAI,EAAE,iBAAiB;IACvB,WAAW,EACT,wFAAwF;IAC1F,KAAK,EAAE,WAAW;CACnB,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,GAAW,EAAE,GAAG,IAAc,EAAE,EAAE,CAAC,KAAK,IAAI,aAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;AAEhG,SAAe,WAAW,CAAC,OAAsB;;QAC/C,MAAM,IAAA,oBAAW,EAAC,mBAAmB,EAAE,EAAE,OAAO,CAAC,CAAA;QACjD,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC/B,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACjC,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;CAAA;AAED,SAAe,gBAAgB,CAAC,OAAsB;;QACpD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAqB,EAAC,GAAG,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACrE,OAAO,CAAC,OAAO,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;YAC7D,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,EAAE,sCAAsC,CAAC,CAAA;IACxD,CAAC;CAAA;AAED,SAAe,kBAAkB,CAAC,OAAsB;;QACtD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAA,kBAAQ,kCACnB,GAAG,CAAC,eAAe,GACnB,CAAC,MAAM,0BAA0B,EAAE,CAAC,EACvC,CAAA;QACF,MAAM,MAAM,qBAAO,GAAG,CAAC,CAAA;QACvB,MAAM,CAAC,eAAe,GAAG,OAAO,CAAA;QAChC,MAAM,IAAA,gCAAsB,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7C,aAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;QAEpC,aAAG,CAAC,IAAI,CACN,eAAK,CAAC,KAAK,CACT,IAAA,iBAAO,EAAA;;;;;;GAMV,CAAC,IAAI,EAAE,CACL,CACF,CAAA;IACH,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,OAAsB;;;QAChD,MAAM,EAAC,QAAQ,EAAC,GAAG,OAAO,CAAA;QAE1B,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,MAAA,CAAC,MAAM,IAAA,gBAAQ,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,mCAAgB,CAAC,CAAC,mCAAI,EAAE,CAAA;QAEjF,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAC,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAA;QAE/E,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAC3E,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,aAAa,CAAC,CAAC,CAAA;QAE/D,IAAI,eAAe,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,EAAE;YACnD,MAAM,aAAa,GAAG,CAAC,GAAG,eAAe,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;iBAClE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,MAAM,CAAC,CAAA;YACf,MAAM,IAAA,iBAAS,EAAC,UAAU,EAAE,aAAa,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;YAC9D,aAAG,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAA;SACvD;;CACF;AAED,SAAe,cAAc,CAAC,OAAsB;;QAClD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;QAErC,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;QAExC,MAAM,QAAQ,GAAG,IAAA,iBAAO,EAAA;;;oDAG0B,GAAG,CAAC,IAAI;;4DAEA,aAAa;GACtE,CAAA;QAED,MAAM,OAAO,GAAG,IAAA,iBAAO,EAAA;;;;yBAIA,GAAG,CAAC,IAAI;;;;;;eAMlB,GAAG,CAAC,IAAI;;GAEpB,CAAA;QAED,MAAM,KAAK,GAAG,IAAA,iBAAO,EAAA;;GAEpB,CAAA;QAED,MAAM,aAAa,GAAG,IAAA,iBAAO,EAAA;;;;;;;;;;;;;;;oCAeK,aAAa;;;;GAI9C,CAAA;QAED,OAAO;YACL,QAAQ;YACR,OAAO;YACP,KAAK;YACL,aAAa;SACd,CAAA;IACH,CAAC;CAAA;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,MAAc,EAAE,QAAkB;IAChE,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;AACpE,CAAC;AAFD,0CAEC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,CAAS,EAAE,CAAS;IACvC,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC5B,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAE5B,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;IAC5F,MAAM,aAAa,GAAG,aAAa,GAAG,MAAM,CAAC,MAAM,GAAG,GAAG,CAAA;IACzD,OAAO,aAAa,CAAA;AACtB,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,EAAC,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,EAAC;QACtF,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,iBAAiB,EAAC;QAClD,EAAC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAC;QAC/B,EAAC,IAAI,EAAE,CAAC,wBAAwB,CAAC,EAAE,EAAE,EAAE,sBAAsB,EAAC;QAC9D,EAAC,IAAI,EAAE,CAAC,yBAAyB,CAAC,EAAE,EAAE,EAAE,uBAAuB,EAAC;KACjE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACb,MAAM,KACT,IAAI,EAAE,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,IACzC,CAAC,CAAA;AACL,CAAC;AAED,SAAe,0BAA0B;;QACvC,OAAO,IAAA,6CAAqB,EAAC;YAC3B,iBAAiB;YACjB,iCAAiC;YACjC,iCAAiC;YACjC,OAAO;YACP,aAAa;SACd,CAAC,CAAA;IACJ,CAAC;CAAA;AAED,SAAgB,aAAa,CAAC,GAAgB;;IAC5C,OAAQ,CAAC,MAAA,MAAA,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,mCAAI,GAAG,CAAC,QAAQ,mCAAI,MAAM,CAAY;SAC/D,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC;SAClC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;SACxB,UAAU,CAAC,mBAAmB,EAAE,aAAa,CAAC;SAC9C,UAAU,CAAC,kBAAkB,EAAE,qBAAqB,CAAC;SACrD,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AAC3B,CAAC;AAPD,sCAOC"}

package/lib/test/semver-workflow.test.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const tap_1 = __importDefault(require("tap"));
 const semver_workflow_1 = require("../src/presets/semver-workflow");
+const outdent_1 = __importDefault(require("outdent"));
 tap_1.default.test('readmeBaseUrl', (t) => __awaiter(void 0, void 0, void 0, function* () {
     const testCases = [
         {
@@ -39,4 +40,38 @@ tap_1.default.test('readmeBaseUrl', (t) => __awaiter(void 0, void 0, void 0, fun
     ];
     testCases.forEach(({ pkg, expectedUrl }) => t.equal((0, semver_workflow_1.readmeBaseurl)(pkg), expectedUrl));
 }));
+tap_1.default.test('missingSections', (t) => __awaiter(void 0, void 0, void 0, function* () {
+    const exactMatch = (0, outdent_1.default) `
+  This a
+  matches b
+  exactly c
+`;
+    const over50PercentMatch = (0, outdent_1.default) `
+  This x
+  matches y
+  enough z
+`;
+    const only50PercentMatch = (0, outdent_1.default) `
+  This
+  does
+  not
+  match
+`;
+    const sections = [exactMatch, over50PercentMatch, only50PercentMatch];
+    const readme = (0, outdent_1.default) `
+    This a
+    matches b
+    exactly c
+
+    This x
+    matches y
+    enough zzzzzz
+
+    This
+    does
+    miss
+  `;
+    const missing = (0, semver_workflow_1.missingSections)(readme, sections);
+    t.same(missing, [only50PercentMatch]);
+}));
 //# sourceMappingURL=semver-workflow.test.js.map

package/lib/test/semver-workflow.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"semver-workflow.test.js","sourceRoot":"","sources":["../../test/semver-workflow.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,8CAAqB;AACrB,oEAA4D;AAG5D,aAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAO,CAAC,EAAE,EAAE;IACpC,MAAM,SAAS,GAA8C;QAC3D;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,6CAA6C,EAAC,EAAC;YACvE,WAAW,EAAE,qCAAqC;SACnD;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,mDAAmD,EAAC,EAAC;YAC7E,WAAW,EAAE,yCAAyC;SACvD;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,uDAAuD,EAAC,EAAC;YACjF,WAAW,EAAE,uDAAuD;SACrE;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,oDAAoD,EAAC,EAAC;YAC9E,WAAW,EAAE,4CAA4C;SAC1D;QACD;YACE,GAAG,EAAE,EAAC,QAAQ,EAAE,wDAAwD,EAAC;YACzE,WAAW,EAAE,iDAAiD;SAC/D;KACF,CAAA;IAED,SAAS,CAAC,OAAO,CAAC,CAAC,EAAC,GAAG,EAAE,WAAW,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAA,+BAAa,EAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;AACrF,CAAC,CAAA,CAAC,CAAA"}
+{"version":3,"file":"semver-workflow.test.js","sourceRoot":"","sources":["../../test/semver-workflow.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,8CAAqB;AACrB,oEAA6E;AAE7E,sDAA6B;AAE7B,aAAG,CAAC,IAAI,CAAC,eAAe,EAAE,CAAO,CAAC,EAAE,EAAE;IACpC,MAAM,SAAS,GAA8C;QAC3D;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,6CAA6C,EAAC,EAAC;YACvE,WAAW,EAAE,qCAAqC;SACnD;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,mDAAmD,EAAC,EAAC;YAC7E,WAAW,EAAE,yCAAyC;SACvD;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,uDAAuD,EAAC,EAAC;YACjF,WAAW,EAAE,uDAAuD;SACrE;QACD;YACE,GAAG,EAAE,EAAC,UAAU,EAAE,EAAC,GAAG,EAAE,oDAAoD,EAAC,EAAC;YAC9E,WAAW,EAAE,4CAA4C;SAC1D;QACD;YACE,GAAG,EAAE,EAAC,QAAQ,EAAE,wDAAwD,EAAC;YACzE,WAAW,EAAE,iDAAiD;SAC/D;KACF,CAAA;IAED,SAAS,CAAC,OAAO,CAAC,CAAC,EAAC,GAAG,EAAE,WAAW,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAA,+BAAa,EAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;AACrF,CAAC,CAAA,CAAC,CAAA;AAEF,aAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAO,CAAC,EAAE,EAAE;IACtC,MAAM,UAAU,GAAG,IAAA,iBAAO,EAAA;;;;CAI3B,CAAA;IACC,MAAM,kBAAkB,GAAG,IAAA,iBAAO,EAAA;;;;CAInC,CAAA;IACC,MAAM,kBAAkB,GAAG,IAAA,iBAAO,EAAA;;;;;CAKnC,CAAA;IACC,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAA;IAErE,MAAM,MAAM,GAAG,IAAA,iBAAO,EAAA;;;;;;;;;;;;GAYrB,CAAA;IAED,MAAM,OAAO,GAAG,IAAA,iCAAe,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACjD,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAA;AACvC,CAAC,CAAA,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/plugin-kit",
-  "version": "1.1.0-ecosystem-preset.8",
+  "version": "1.1.0-ecosystem-preset.9",
   "description": "Enhanced Sanity.io plugin development experience",
   "scripts": {
     "clean": "rimraf lib",

package/src/presets/semver-workflow.ts

@@ -71,10 +71,18 @@ async function updateReadme(options: InjectOptions) {
   const readmePath = path.join(basePath, 'README.md')
   const readme = (await readFile(readmePath, 'utf8').catch(errorToUndefined)) ?? ''
 
-  const {v3Banner, installUsage, developFooter} = await readmeSnippets(options)
-  const updatedReadme = [v3Banner, installUsage, readme, developFooter].filter(Boolean).join('\n\n')
-  await writeFile(readmePath, updatedReadme, {encoding: 'utf8'})
-  log.info('Updated README. Please review the changes.')
+  const {v3Banner, install, usage, developFooter} = await readmeSnippets(options)
+
+  const prependSections = missingSections(readme, [v3Banner, install, usage])
+  const appendSections = missingSections(readme, [developFooter])
+
+  if (prependSections.length || appendSections.length) {
+    const updatedReadme = [...prependSections, readme, ...appendSections]
+      .filter(Boolean)
+      .join('\n\n')
+    await writeFile(readmePath, updatedReadme, {encoding: 'utf8'})
+    log.info('Updated README. Please review the changes.')
+  }
 }
 
 async function readmeSnippets(options: InjectOptions) {
@@ -90,7 +98,7 @@ async function readmeSnippets(options: InjectOptions) {
     > For the v2 version, please refer to the [v2-branch](${bestEffortUrl}).
   `
 
-  const installUsage = outdent`
+  const install = outdent`
     ## Installation
 
     \`\`\`
@@ -102,10 +110,10 @@ async function readmeSnippets(options: InjectOptions) {
     \`\`\`
     yarn add ${pkg.name}@studio-v3
     \`\`\`
+  `
 
+  const usage = outdent`
     ## Usage
-
-    <TODO: Show usage here>
   `
 
   const developFooter = outdent`
@@ -131,18 +139,40 @@ async function readmeSnippets(options: InjectOptions) {
 
   return {
     v3Banner,
-    installUsage,
+    install,
+    usage,
     developFooter,
   }
 }
 
+/**
+ * Returns sections that does not exists "close enough" in readme
+ */
+export function missingSections(readme: string, sections: string[]) {
+  return sections.filter((section) => !closeEnough(section, readme))
+}
+
+/**
+ * a and b are considered "close enough" if > 50% of a lines exist in b lines
+ * @param a
+ * @param b
+ */
+function closeEnough(a: string, b: string) {
+  const aLines = a.split('\n')
+  const bLines = b.split('\n')
+
+  const matchingLines = aLines.filter((line) => bLines.find((bLine) => bLine === line)).length
+  const isCloseEnough = matchingLines > aLines.length * 0.5
+  return isCloseEnough
+}
+
 function semverWorkflowFiles(): FromTo[] {
   return [
     {from: ['.github', 'workflows', 'main.yml'], to: ['.github', 'workflows', 'main.yml']},
     {from: ['.husky', 'commit-msg'], to: ['.husky', 'commit-msg']},
     {from: ['.husky', 'pre-commit'], to: ['.husky', 'pre-commit']},
     {from: ['.releaserc.json'], to: '.releaserc.json'},
-    {from: ['.npmrc'], to: '.npmrc'},
+    {from: ['npmrc'], to: '.npmrc'},
     {from: ['commitlint.template.js'], to: 'commitlint.config.js'},
     {from: ['lint-staged.template.js'], to: 'lint-staged.config.js'},
   ].map((fromTo) => ({