npm - @anolilab/textlint-config - Versions diffs - 4.2.2 → 5.0.1 - Mend

@anolilab/textlint-config 4.2.2 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,27 @@
+## @anolilab/textlint-config [5.0.1](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/textlint-config@5.0.0...@anolilab/textlint-config@5.0.1) (2023-06-10)
+### Bug Fixes
+* changed lib from js to ts ([9ffbaae](https://github.com/anolilab/javascript-style-guide/commit/9ffbaaee395c9f5345adcd97cb8c3c2e77af86eb))
+## @anolilab/textlint-config [5.0.0](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/textlint-config@4.2.2...@anolilab/textlint-config@5.0.0) (2023-06-10)
+### ⚠ BREAKING CHANGES
+* Changed the package to support cjs and mjs, so the type module was removed
+### Features
+* switched js to ts, created a new package-utils package ([5477591](https://github.com/anolilab/javascript-style-guide/commit/5477591aa46d878b8535ff8503384e27ca537a7f))
+### Dependencies
+* **@anolilab/semantic-release-preset:** upgraded to 3.0.0
 ## @anolilab/textlint-config [4.2.2](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/textlint-config@4.2.1...@anolilab/textlint-config@4.2.2) (2023-05-26)
@@ -323,7 +347,7 @@ Signed-off-by: prisis <d.bannert@anolilab.de>
 ### Bug Fixes
--   removed index.cjs from text-lint ([e5ab6d6](https://github.com/anolilab/javascript-style-guide/commit/e5ab6d6a9214b288646d471e19afff163ac5cf57))
+-   removed index.ts from text-lint ([e5ab6d6](https://github.com/anolilab/javascript-style-guide/commit/e5ab6d6a9214b288646d471e19afff163ac5cf57))
 ### @anolilab/textlint-config [2.0.2](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/textlint-config@2.0.1...@anolilab/textlint-config@2.0.2) (2021-05-04)

package/README.md CHANGED Viewed

@@ -20,157 +20,156 @@ Anolilab Coding Standard for text linting.
 npm install --dev-save @anolilab/textlint-config textlint
 ```
+```sh
+$ yarn add -D @anolilab/textlint-config textlint
+```
+```sh
+$ pnpm add -D @anolilab/textlint-config textlint
+```
 ## Usage
 If you don’t have a `.textlintrc`, we will create the file for you after installing `@anolilab/textlint-config`.
 If you already have a `.textlintrc`, then you can extend the `.textlintrc`, with `@anolilab/textlint-config`.
-```text
+```json5
 {
-  "filters": {
-    "comments": true
-  },
-  "rules": {
-    "en-capitalization": true,
-    "footnote-order": true,
-    "no-todo": true,
-    "no-dead-link": {
-        "ignore": [
-            "bc_data_*",
-        ]
-    },
-    "no-empty-section": true,
-    "terminology": true,
-    "apostrophe": true,
-    "diacritics": true,
-    "@textlint-rule/no-invalid-control-character": true,
-    "@textlint-rule/no-unmatched-pair": true,
-    "abbr-within-parentheses": true,
-    "alex": {
-        "allow": [
-            "period",
-            "european",
-            "failure",
-            "fore",
-            "attack",
-            "execution",
-            "executed",
-            "remain",
-            "execute"
-        ]
+    "@textlint/markdown": {
+        "extensions": [".md", ".mdx"]
     },
-    "@textlint-rule/preset-google": true,
-    "write-good": {
-      "passive": false,
-      "eprime": false,
+    "filters": {
+        "comments": true
     },
-    "common-misspellings": true,
-    "terminology": {
-      "defaultTerms": false,
-      "terms": [
-        // Abbreviations
-        "API",
-        ["API['’]?s", "APIs"],
-        "Ajax",
-        "CLI",
-        "CSS",
-        "CORS",
-        ["^E2E", "E2E"],
-        "gif",
-        ["^HTML", "HTML"],
-        ["^URL(s?)", "URL$1"],
-        ["^HTTP", "HTTP"],
-        ["^HTTPS", "HTTPS"],
-        "SSO",
-        ["^XHR(s?)", "XHR$1"],
-        ["^XHR['’]?s", "XHRs"],
-        "Xvfb",
-        "YAML",
-        // Words and phrases
-        ["\\(s\\)he", "they"],
-        ["he or she", "they"],
-        ["he/she", "they"],
-        ["crazy", "complex"],
-        ["crazier", "more complex"],
-        ["craziest", "most complex"],
-        ["dumb", "unintended"],
-        ["insane", "outrageous"],
-        // Prefer American spelling
-        ["behaviour", "behavior"],
-        ["cancelled", "canceled"],
-        ["cancelling", "canceling"],
-        ["centre", "center"],
-        ["colour", "color"],
-        ["customise", "customize"],
-        ["customisation", "customization"],
-        ["favourite", "favorite"],
-        ["labelled", "labeled"],
-        ["licence", "license"],
-        ["organise", "organize"],
-        // Common misspellings
-        ["gaurantee", "guarantee"],
-        // Words we would like to not use altogether
-        ["simply", ""],
-        // Single word
-        ["change[- ]log(s?)", "changelog$1"],
-        ["code[- ]base(es?)", "codebase$1"],
-        ["e[- ]mail(s?)", "email$1"],
-        ["end[- ]point(s?)", "endpoint$1"],
-        ["file[- ]name(s?)", "filename$1"],
-        ["can[- ]not", "cannot$1"],
-        // Multiple words
-        ["back-?end(s?)", "back end$1"],
-        ["front-?end(s?)", "front end$1"],
-        ["full-?stack(s?)", "full stack$1"],
-        ["open-?source(ed?)", "open source$1"],
-        ["web-?page(s?)", "web page$1"],
-        // Hyphenated
-        ["end ?to ?end", "end-to-end"],
-        ["retryability", "retry-ability"],
-        ["retriability", "retry-ability"],
-        ["some", ""],
-        ["filetype", "file type"],
-        ["stylesheet", "style sheet"],
-        ["like this", ""],
-        ["probably", ""],
-        ["known as", ""],
-        ["really", ""],
-        ["just", ""],
-        ["simple", ""],
-        ["obvious", ""],
-        ["straightforward", ""],
-        ["very", ""],
-        ["a little", ""],
-        ["note that", ""],
-        ["good to note", ""],
-        ["good to remember", ""],
-        ["basically", ""],
-        ["actually", ""],
-        ["pretty", ""],
-        ["easy", ""],
-        ["interesting", ""],
-        ["way to", ""],
-        ["In order to", "To"],
-        ["in order to", "to"],
-        ["might", ""],
-        ["us", ""],
-        ["I'll", ""],
-        ["I've", ""],
-        ["they'll", ""],
-        ["it is", "it's"],
-        ["It is", "It's"],
-      ]
+    "rules": {
+        "en-capitalization": true,
+        "footnote-order": true,
+        "no-todo": true,
+        "no-dead-link": {
+            "ignore": ["bc_data_*"]
+        },
+        "no-empty-section": true,
+        "terminology": true,
+        "apostrophe": true,
+        "diacritics": true,
+        "@textlint-rule/no-invalid-control-character": true,
+        "@textlint-rule/no-unmatched-pair": true,
+        "abbr-within-parentheses": true,
+        "alex": {
+            "allow": ["period", "european", "failure", "fore", "attack", "execution", "executed", "remain", "execute"]
+        },
+        "@textlint-rule/preset-google": true,
+        "write-good": {
+            "passive": false,
+            "eprime": false
+        },
+        "common-misspellings": true,
+        "terminology": {
+            "defaultTerms": false,
+            "terms": [
+                // Abbreviations
+                "API",
+                ["API['’]?s", "APIs"],
+                "Ajax",
+                "CLI",
+                "CSS",
+                "CORS",
+                ["^E2E", "E2E"],
+                "gif",
+                ["^HTML", "HTML"],
+                ["^URL(s?)", "URL$1"],
+                ["^HTTP", "HTTP"],
+                ["^HTTPS", "HTTPS"],
+                "SSO",
+                ["^XHR(s?)", "XHR$1"],
+                ["^XHR['’]?s", "XHRs"],
+                "Xvfb",
+                "YAML",
+                // Words and phrases
+                ["\\(s\\)he", "they"],
+                ["he or she", "they"],
+                ["he/she", "they"],
+                ["crazy", "complex"],
+                ["crazier", "more complex"],
+                ["craziest", "most complex"],
+                ["dumb", "unintended"],
+                ["insane", "outrageous"],
+                // Prefer American spelling
+                ["behaviour", "behavior"],
+                ["cancelled", "canceled"],
+                ["cancelling", "canceling"],
+                ["centre", "center"],
+                ["colour", "color"],
+                ["customise", "customize"],
+                ["customisation", "customization"],
+                ["favourite", "favorite"],
+                ["labelled", "labeled"],
+                ["licence", "license"],
+                ["organise", "organize"],
+                // Common misspellings
+                ["gaurantee", "guarantee"],
+                // Words we would like to not use altogether
+                ["simply", ""],
+                // Single word
+                ["change[- ]log(s?)", "changelog$1"],
+                ["code[- ]base(es?)", "codebase$1"],
+                ["e[- ]mail(s?)", "email$1"],
+                ["end[- ]point(s?)", "endpoint$1"],
+                ["file[- ]name(s?)", "filename$1"],
+                ["can[- ]not", "cannot$1"],
+                // Multiple words
+                ["back-?end(s?)", "back end$1"],
+                ["front-?end(s?)", "front end$1"],
+                ["full-?stack(s?)", "full stack$1"],
+                ["open-?source(ed?)", "open source$1"],
+                ["web-?page(s?)", "web page$1"],
+                // Hyphenated
+                ["end ?to ?end", "end-to-end"],
+                ["retryability", "retry-ability"],
+                ["retriability", "retry-ability"],
+                ["some", ""],
+                ["filetype", "file type"],
+                ["stylesheet", "style sheet"],
+                ["like this", ""],
+                ["probably", ""],
+                ["known as", ""],
+                ["really", ""],
+                ["just", ""],
+                ["simple", ""],
+                ["obvious", ""],
+                ["straightforward", ""],
+                ["very", ""],
+                ["a little", ""],
+                ["note that", ""],
+                ["good to note", ""],
+                ["good to remember", ""],
+                ["basically", ""],
+                ["actually", ""],
+                ["pretty", ""],
+                ["easy", ""],
+                ["interesting", ""],
+                ["way to", ""],
+                ["In order to", "To"],
+                ["in order to", "to"],
+                ["might", ""],
+                ["us", ""],
+                ["I'll", ""],
+                ["I've", ""],
+                ["they'll", ""],
+                ["it is", "it's"],
+                ["It is", "It's"]
+            ]
+        }
     }
-  }
 }
 ```

package/dist/postinstall.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ #!/usr/bin/env node

package/dist/postinstall.js ADDED Viewed

@@ -0,0 +1,149 @@
+#!/usr/bin/env node
+'use strict';
+var fs = require('fs');
+var path = require('path');
+var util = require('util');
+process.env.CI&&process.exit(0);var i=util.promisify(fs.writeFile),o=path.resolve(process.cwd(),"..","..","..");console.log("Configuring @anolilab/textlint-config",o,`
+`);var c=()=>{let e=path.join(o,".textlintrc"),t=`{
+    "@textlint/markdown": {
+        "extensions": [".md", ".mdx"]
+    },
+    "filters": {
+        "comments": true
+    },
+    "rules": {
+        "en-capitalization": true,
+        "footnote-order": true,
+        "no-todo": true,
+        "no-dead-link": {
+            "ignore": ["bc_data_*"]
+        },
+        "no-empty-section": true,
+        "terminology": true,
+        "apostrophe": true,
+        "diacritics": true,
+        "@textlint-rule/no-invalid-control-character": true,
+        "@textlint-rule/no-unmatched-pair": true,
+        "abbr-within-parentheses": true,
+        "alex": {
+            "allow": ["period", "european", "failure", "fore", "attack", "execution", "executed", "remain", "execute"]
+        },
+        "@textlint-rule/preset-google": true,
+        "write-good": {
+            "passive": false,
+            "eprime": false
+        },
+        "common-misspellings": true,
+        "terminology": {
+            "defaultTerms": false,
+            "terms": [
+                // Abbreviations
+                "API",
+                ["API['\u2019]?s", "APIs"],
+                "Ajax",
+                "CLI",
+                "CSS",
+                "CORS",
+                ["^E2E", "E2E"],
+                "gif",
+                ["^HTML", "HTML"],
+                ["^URL(s?)", "URL$1"],
+                ["^HTTP", "HTTP"],
+                ["^HTTPS", "HTTPS"],
+                "SSO",
+                ["^XHR(s?)", "XHR$1"],
+                ["^XHR['\u2019]?s", "XHRs"],
+                "Xvfb",
+                "YAML",
+                // Words and phrases
+                ["\\(s\\)he", "they"],
+                ["he or she", "they"],
+                ["he/she", "they"],
+                ["crazy", "complex"],
+                ["crazier", "more complex"],
+                ["craziest", "most complex"],
+                ["dumb", "unintended"],
+                ["insane", "outrageous"],
+                // Prefer American spelling
+                ["behaviour", "behavior"],
+                ["cancelled", "canceled"],
+                ["cancelling", "canceling"],
+                ["centre", "center"],
+                ["colour", "color"],
+                ["customise", "customize"],
+                ["customisation", "customization"],
+                ["favourite", "favorite"],
+                ["labelled", "labeled"],
+                ["licence", "license"],
+                ["organise", "organize"],
+                // Common misspellings
+                ["gaurantee", "guarantee"],
+                // Words we would like to not use altogether
+                ["simply", ""],
+                // Single word
+                ["change[- ]log(s?)", "changelog$1"],
+                ["code[- ]base(es?)", "codebase$1"],
+                ["e[- ]mail(s?)", "email$1"],
+                ["end[- ]point(s?)", "endpoint$1"],
+                ["file[- ]name(s?)", "filename$1"],
+                ["can[- ]not", "cannot$1"],
+                // Multiple words
+                ["back-?end(s?)", "back end$1"],
+                ["front-?end(s?)", "front end$1"],
+                ["full-?stack(s?)", "full stack$1"],
+                ["open-?source(ed?)", "open source$1"],
+                ["web-?page(s?)", "web page$1"],
+                // Hyphenated
+                ["end ?to ?end", "end-to-end"],
+                ["retryability", "retry-ability"],
+                ["retriability", "retry-ability"],
+                ["some", ""],
+                ["filetype", "file type"],
+                ["stylesheet", "style sheet"],
+                ["like this", ""],
+                ["probably", ""],
+                ["known as", ""],
+                ["really", ""],
+                ["just", ""],
+                ["simple", ""],
+                ["obvious", ""],
+                ["straightforward", ""],
+                ["very", ""],
+                ["a little", ""],
+                ["note that", ""],
+                ["good to note", ""],
+                ["good to remember", ""],
+                ["basically", ""],
+                ["actually", ""],
+                ["pretty", ""],
+                ["easy", ""],
+                ["interesting", ""],
+                ["way to", ""],
+                ["In order to", "To"],
+                ["in order to", "to"],
+                ["might", ""],
+                ["us", ""],
+                ["I'll", ""],
+                ["I've", ""],
+                ["they'll", ""],
+                ["it is", "it's"],
+                ["It is", "It's"]
+            ]
+        }
+    }
+}
+`;return fs.existsSync(e)?(console.warn(`\u26A0\uFE0F  .textlintrc already exists;
+Make sure that it includes the following for @anolilab/textlint-config'
+to work as it should: ${t}.`),Promise.resolve()):i(e,t,"utf-8")},u=()=>{let e=path.join(o,".textlintignore"),t="";return fs.existsSync(e)?(console.warn("\u26A0\uFE0F  .textlintignore already exists;"),Promise.resolve()):i(e,t,"utf-8")};(async()=>{try{await c(),await u(),console.log("\u{1F60E}  Everything went well, have fun!"),process.exit(0);}catch(e){console.log("\u{1F62C}  something went wrong:"),console.error(e),process.exit(1);}})();
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=postinstall.js.map

package/dist/postinstall.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/postinstall.ts"],"names":["existsSync","writeFile","join","resolve","promisify","writeFileAsync","projectPath","writeTextLintRc","filePath","content","writeTextLintIgnore","error"],"mappings":";AAEA,OAAS,cAAAA,EAAY,aAAAC,MAAiB,KACtC,OAAS,QAAAC,EAAM,WAAAC,MAAe,OAC9B,OAAS,aAAAC,MAAiB,OAEtB,QAAQ,IAAI,IAEZ,QAAQ,KAAK,CAAC,EAGlB,IAAMC,EAAiBD,EAAUH,CAAS,EAIpCK,EAAcH,EAAQ,QAAQ,IAAI,EAAG,KAAM,KAAM,IAAI,EAE3D,QAAQ,IAAI,wCAAyCG,EAAa;AAAA,CAAI,EAKtE,IAAMC,EAAkB,IAAM,CAC1B,IAAMC,EAAWN,EAAKI,EAAa,aAAa,EAC1CG,EAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0IhB,OAAIT,EAAWQ,CAAQ,GACnB,QAAQ,KAAK;AAAA;AAAA,wBAEGC,IAAU,EAEnB,QAAQ,QAAQ,GAGpBJ,EAAeG,EAAUC,EAAS,OAAO,CACpD,EAKMC,EAAsB,IAAM,CAC9B,IAAMF,EAAWN,EAAKI,EAAa,iBAAiB,EAC9CG,EAAU,GAEhB,OAAIT,EAAWQ,CAAQ,GACnB,QAAQ,KAAK,+CAAqC,EAE3C,QAAQ,QAAQ,GAGpBH,EAAeG,EAAUC,EAAS,OAAO,CACpD,GAGC,SAAY,CACT,GAAI,CACA,MAAMF,EAAgB,EACtB,MAAMG,EAAoB,EAE1B,QAAQ,IAAI,4CAAqC,EAGjD,QAAQ,KAAK,CAAC,CAClB,OAASC,EAAP,CACE,QAAQ,IAAI,kCAA2B,EACvC,QAAQ,MAAMA,CAAK,EAGnB,QAAQ,KAAK,CAAC,CAClB,CACJ,GAAG","sourcesContent":["#!/usr/bin/env node\n\nimport { existsSync, writeFile } from \"node:fs\";\nimport { join, resolve } from \"node:path\";\nimport { promisify } from \"node:util\";\n\nif (process.env[\"CI\"]) {\n // eslint-disable-next-line no-undef\n process.exit(0);\n}\n\nconst writeFileAsync = promisify(writeFile);\n\n// get the path to the host project.\n// eslint-disable-next-line no-undef\nconst projectPath = resolve(process.cwd(), \"..\", \"..\", \"..\");\n\nconsole.log(\"Configuring @anolilab/textlint-config\", projectPath, \"\\n\");\n\n/**\n * Writes .textlintrc if it doesn't exist. Warns if it exists.\n */\nconst writeTextLintRc = () => {\n const filePath = join(projectPath, \".textlintrc\");\n const content = `{\n \"@textlint/markdown\": {\n \"extensions\": [\".md\", \".mdx\"]\n },\n \"filters\": {\n \"comments\": true\n },\n \"rules\": {\n \"en-capitalization\": true,\n \"footnote-order\": true,\n \"no-todo\": true,\n \"no-dead-link\": {\n \"ignore\": [\"bc_data_*\"]\n },\n \"no-empty-section\": true,\n \"terminology\": true,\n \"apostrophe\": true,\n \"diacritics\": true,\n \"@textlint-rule/no-invalid-control-character\": true,\n \"@textlint-rule/no-unmatched-pair\": true,\n \"abbr-within-parentheses\": true,\n \"alex\": {\n \"allow\": [\"period\", \"european\", \"failure\", \"fore\", \"attack\", \"execution\", \"executed\", \"remain\", \"execute\"]\n },\n \"@textlint-rule/preset-google\": true,\n \"write-good\": {\n \"passive\": false,\n \"eprime\": false\n },\n \"common-misspellings\": true,\n \"terminology\": {\n \"defaultTerms\": false,\n \"terms\": [\n // Abbreviations\n \"API\",\n [\"API['’]?s\", \"APIs\"],\n \"Ajax\",\n \"CLI\",\n \"CSS\",\n \"CORS\",\n [\"^E2E\", \"E2E\"],\n \"gif\",\n [\"^HTML\", \"HTML\"],\n [\"^URL(s?)\", \"URL$1\"],\n [\"^HTTP\", \"HTTP\"],\n [\"^HTTPS\", \"HTTPS\"],\n \"SSO\",\n [\"^XHR(s?)\", \"XHR$1\"],\n [\"^XHR['’]?s\", \"XHRs\"],\n \"Xvfb\",\n \"YAML\",\n\n // Words and phrases\n [\"\\\$s\\\$he\", \"they\"],\n [\"he or she\", \"they\"],\n [\"he/she\", \"they\"],\n [\"crazy\", \"complex\"],\n [\"crazier\", \"more complex\"],\n [\"craziest\", \"most complex\"],\n [\"dumb\", \"unintended\"],\n [\"insane\", \"outrageous\"],\n\n // Prefer American spelling\n [\"behaviour\", \"behavior\"],\n [\"cancelled\", \"canceled\"],\n [\"cancelling\", \"canceling\"],\n [\"centre\", \"center\"],\n [\"colour\", \"color\"],\n [\"customise\", \"customize\"],\n [\"customisation\", \"customization\"],\n [\"favourite\", \"favorite\"],\n [\"labelled\", \"labeled\"],\n [\"licence\", \"license\"],\n [\"organise\", \"organize\"],\n\n // Common misspellings\n [\"gaurantee\", \"guarantee\"],\n\n // Words we would like to not use altogether\n [\"simply\", \"\"],\n\n // Single word\n [\"change[- ]log(s?)\", \"changelog$1\"],\n [\"code[- ]base(es?)\", \"codebase$1\"],\n [\"e[- ]mail(s?)\", \"email$1\"],\n [\"end[- ]point(s?)\", \"endpoint$1\"],\n [\"file[- ]name(s?)\", \"filename$1\"],\n [\"can[- ]not\", \"cannot$1\"],\n\n // Multiple words\n [\"back-?end(s?)\", \"back end$1\"],\n [\"front-?end(s?)\", \"front end$1\"],\n [\"full-?stack(s?)\", \"full stack$1\"],\n [\"open-?source(ed?)\", \"open source$1\"],\n [\"web-?page(s?)\", \"web page$1\"],\n\n // Hyphenated\n [\"end ?to ?end\", \"end-to-end\"],\n [\"retryability\", \"retry-ability\"],\n [\"retriability\", \"retry-ability\"],\n\n [\"some\", \"\"],\n [\"filetype\", \"file type\"],\n [\"stylesheet\", \"style sheet\"],\n [\"like this\", \"\"],\n [\"probably\", \"\"],\n [\"known as\", \"\"],\n [\"really\", \"\"],\n [\"just\", \"\"],\n [\"simple\", \"\"],\n [\"obvious\", \"\"],\n [\"straightforward\", \"\"],\n [\"very\", \"\"],\n [\"a little\", \"\"],\n [\"note that\", \"\"],\n [\"good to note\", \"\"],\n [\"good to remember\", \"\"],\n [\"basically\", \"\"],\n [\"actually\", \"\"],\n [\"pretty\", \"\"],\n [\"easy\", \"\"],\n [\"interesting\", \"\"],\n [\"way to\", \"\"],\n [\"In order to\", \"To\"],\n [\"in order to\", \"to\"],\n [\"might\", \"\"],\n [\"us\", \"\"],\n [\"I'll\", \"\"],\n [\"I've\", \"\"],\n [\"they'll\", \"\"],\n [\"it is\", \"it's\"],\n [\"It is\", \"It's\"]\n ]\n }\n }\n}\n`;\n\n if (existsSync(filePath)) {\n console.warn(`⚠️ .textlintrc already exists;\nMake sure that it includes the following for @anolilab/textlint-config'\nto work as it should: ${content}.`);\n\n return Promise.resolve();\n }\n\n return writeFileAsync(filePath, content, \"utf-8\");\n};\n\n/**\n * Writes .textlintignore if it doesn't exist. Warns if it exists.\n */\nconst writeTextLintIgnore = () => {\n const filePath = join(projectPath, \".textlintignore\");\n const content = \"\";\n\n if (existsSync(filePath)) {\n console.warn(\"⚠️ .textlintignore already exists;\");\n\n return Promise.resolve();\n }\n\n return writeFileAsync(filePath, content, \"utf-8\");\n};\n\n// eslint-disable-next-line unicorn/prefer-top-level-await\n(async () => {\n try {\n await writeTextLintRc();\n await writeTextLintIgnore();\n\n console.log(\"😎 Everything went well, have fun!\");\n\n // eslint-disable-next-line no-undef\n process.exit(0);\n } catch (error) {\n console.log(\"😬 something went wrong:\");\n console.error(error);\n\n // eslint-disable-next-line no-undef\n process.exit(1);\n }\n})();\n"]}

package/dist/postinstall.mjs ADDED Viewed

@@ -0,0 +1,147 @@
+#!/usr/bin/env node
+import { writeFile, existsSync } from 'fs';
+import { resolve, join } from 'path';
+import { promisify } from 'util';
+process.env.CI&&process.exit(0);var i=promisify(writeFile),o=resolve(process.cwd(),"..","..","..");console.log("Configuring @anolilab/textlint-config",o,`
+`);var c=()=>{let e=join(o,".textlintrc"),t=`{
+    "@textlint/markdown": {
+        "extensions": [".md", ".mdx"]
+    },
+    "filters": {
+        "comments": true
+    },
+    "rules": {
+        "en-capitalization": true,
+        "footnote-order": true,
+        "no-todo": true,
+        "no-dead-link": {
+            "ignore": ["bc_data_*"]
+        },
+        "no-empty-section": true,
+        "terminology": true,
+        "apostrophe": true,
+        "diacritics": true,
+        "@textlint-rule/no-invalid-control-character": true,
+        "@textlint-rule/no-unmatched-pair": true,
+        "abbr-within-parentheses": true,
+        "alex": {
+            "allow": ["period", "european", "failure", "fore", "attack", "execution", "executed", "remain", "execute"]
+        },
+        "@textlint-rule/preset-google": true,
+        "write-good": {
+            "passive": false,
+            "eprime": false
+        },
+        "common-misspellings": true,
+        "terminology": {
+            "defaultTerms": false,
+            "terms": [
+                // Abbreviations
+                "API",
+                ["API['\u2019]?s", "APIs"],
+                "Ajax",
+                "CLI",
+                "CSS",
+                "CORS",
+                ["^E2E", "E2E"],
+                "gif",
+                ["^HTML", "HTML"],
+                ["^URL(s?)", "URL$1"],
+                ["^HTTP", "HTTP"],
+                ["^HTTPS", "HTTPS"],
+                "SSO",
+                ["^XHR(s?)", "XHR$1"],
+                ["^XHR['\u2019]?s", "XHRs"],
+                "Xvfb",
+                "YAML",
+                // Words and phrases
+                ["\\(s\\)he", "they"],
+                ["he or she", "they"],
+                ["he/she", "they"],
+                ["crazy", "complex"],
+                ["crazier", "more complex"],
+                ["craziest", "most complex"],
+                ["dumb", "unintended"],
+                ["insane", "outrageous"],
+                // Prefer American spelling
+                ["behaviour", "behavior"],
+                ["cancelled", "canceled"],
+                ["cancelling", "canceling"],
+                ["centre", "center"],
+                ["colour", "color"],
+                ["customise", "customize"],
+                ["customisation", "customization"],
+                ["favourite", "favorite"],
+                ["labelled", "labeled"],
+                ["licence", "license"],
+                ["organise", "organize"],
+                // Common misspellings
+                ["gaurantee", "guarantee"],
+                // Words we would like to not use altogether
+                ["simply", ""],
+                // Single word
+                ["change[- ]log(s?)", "changelog$1"],
+                ["code[- ]base(es?)", "codebase$1"],
+                ["e[- ]mail(s?)", "email$1"],
+                ["end[- ]point(s?)", "endpoint$1"],
+                ["file[- ]name(s?)", "filename$1"],
+                ["can[- ]not", "cannot$1"],
+                // Multiple words
+                ["back-?end(s?)", "back end$1"],
+                ["front-?end(s?)", "front end$1"],
+                ["full-?stack(s?)", "full stack$1"],
+                ["open-?source(ed?)", "open source$1"],
+                ["web-?page(s?)", "web page$1"],
+                // Hyphenated
+                ["end ?to ?end", "end-to-end"],
+                ["retryability", "retry-ability"],
+                ["retriability", "retry-ability"],
+                ["some", ""],
+                ["filetype", "file type"],
+                ["stylesheet", "style sheet"],
+                ["like this", ""],
+                ["probably", ""],
+                ["known as", ""],
+                ["really", ""],
+                ["just", ""],
+                ["simple", ""],
+                ["obvious", ""],
+                ["straightforward", ""],
+                ["very", ""],
+                ["a little", ""],
+                ["note that", ""],
+                ["good to note", ""],
+                ["good to remember", ""],
+                ["basically", ""],
+                ["actually", ""],
+                ["pretty", ""],
+                ["easy", ""],
+                ["interesting", ""],
+                ["way to", ""],
+                ["In order to", "To"],
+                ["in order to", "to"],
+                ["might", ""],
+                ["us", ""],
+                ["I'll", ""],
+                ["I've", ""],
+                ["they'll", ""],
+                ["it is", "it's"],
+                ["It is", "It's"]
+            ]
+        }
+    }
+}
+`;return existsSync(e)?(console.warn(`\u26A0\uFE0F  .textlintrc already exists;
+Make sure that it includes the following for @anolilab/textlint-config'
+to work as it should: ${t}.`),Promise.resolve()):i(e,t,"utf-8")},u=()=>{let e=join(o,".textlintignore"),t="";return existsSync(e)?(console.warn("\u26A0\uFE0F  .textlintignore already exists;"),Promise.resolve()):i(e,t,"utf-8")};(async()=>{try{await c(),await u(),console.log("\u{1F60E}  Everything went well, have fun!"),process.exit(0);}catch(e){console.log("\u{1F62C}  something went wrong:"),console.error(e),process.exit(1);}})();
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=postinstall.mjs.map

package/dist/postinstall.mjs.map ADDED Viewed

@@ -0,0 +1 @@

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@anolilab/textlint-config",
-    "version": "4.2.2",
+    "version": "5.0.1",
     "description": "Anolilab Coding Standard for text linting.",
     "keywords": [
         "anolilab",
@@ -30,42 +30,45 @@
         "name": "Daniel Bannert",
         "email": "d.bannert@anolilab.de"
     },
-    "type": "module",
+    "source": "src/postinstall.ts",
     "files": [
-        "lib",
+        "dist",
         "README.md",
         "CHANGELOG.md",
         "LICENSE.md"
     ],
     "scripts": {
-        "postinstall": "node lib/postinstall.js"
+        "build": "cross-env NODE_ENV=development tsup",
+        "build:prod": "cross-env NODE_ENV=production tsup",
+        "clean": "rimraf node_modules dist",
+        "postinstall": "node ./skip.js || node ./dist/postinstall.js"
     },
     "dependencies": {
-        "@textlint-rule/textlint-rule-no-invalid-control-character": "2.0.0",
-        "@textlint-rule/textlint-rule-no-unmatched-pair": "1.0.9",
-        "@textlint-rule/textlint-rule-preset-google": "0.1.2",
+        "@textlint-rule/textlint-rule-no-invalid-control-character": "^2.0.0",
+        "@textlint-rule/textlint-rule-no-unmatched-pair": "^1.0.9",
+        "@textlint-rule/textlint-rule-preset-google": "^0.1.2",
         "@textlint/ast-node-types": "^13.3.2",
         "@textlint/types": "^13.3.2",
         "textlint-filter-rule-comments": "^1.2.2",
-        "textlint-rule-abbr-within-parentheses": "1.0.2",
-        "textlint-rule-alex": "3.0.0",
-        "textlint-rule-apostrophe": "2.0.0",
-        "textlint-rule-common-misspellings": "1.0.1",
+        "textlint-rule-abbr-within-parentheses": "^1.0.2",
+        "textlint-rule-alex": "^3.0.0",
+        "textlint-rule-apostrophe": "^2.0.0",
+        "textlint-rule-common-misspellings": "^1.0.1",
         "textlint-rule-date-weekday-mismatch": "^1.0.6",
-        "textlint-rule-diacritics": "1.0.0",
-        "textlint-rule-en-capitalization": "2.0.3",
-        "textlint-rule-footnote-order": "1.0.3",
-        "textlint-rule-helper": "2.3.0",
-        "textlint-rule-no-dead-link": "5.1.2",
-        "textlint-rule-no-empty-section": "1.1.0",
-        "textlint-rule-no-todo": "2.0.1",
-        "textlint-rule-terminology": "3.0.4",
-        "textlint-rule-write-good": "2.0.0",
-        "write-good": "1.0.8"
+        "textlint-rule-diacritics": "^1.0.0",
+        "textlint-rule-en-capitalization": "^2.0.3",
+        "textlint-rule-footnote-order": "^1.0.3",
+        "textlint-rule-helper": "^2.3.0",
+        "textlint-rule-no-dead-link": "^5.1.2",
+        "textlint-rule-no-empty-section": "^1.1.0",
+        "textlint-rule-no-todo": "^2.0.1",
+        "textlint-rule-terminology": "^3.0.4",
+        "textlint-rule-write-good": "^2.0.0",
+        "write-good": "^1.0.8"
     },
     "devDependencies": {
-        "textlint": "^13.3.2",
-        "@anolilab/semantic-release-preset": "2.2.1"
+        "@anolilab/semantic-release-preset": "3.0.0",
+        "textlint": "^13.3.2"
     },
     "peerDependencies": {
         "textlint": "^13.3.2"
@@ -74,23 +77,7 @@
         "node": ">=16"
     },
     "publishConfig": {
-        "access": "public"
-    },
-    "pnpm": {
-        "overrides": {
-            "glob-parent@<5.1.2": ">=5.1.2",
-            "minimist@<1.2.6": ">=1.2.6",
-            "chrono-node@<2.2.4": ">=2.2.4",
-            "yargs-parser@>=6.0.0 <13.1.2": ">=13.1.2",
-            "trim@<0.0.3": ">=0.0.3",
-            "trim-newlines@<3.0.1": ">=3.0.1",
-            "moment@<2.29.2": ">=2.29.2",
-            "semver-regex@<3.1.4": ">=3.1.4",
-            "npm@>=7.9.0 <8.11.0": ">=8.11.0",
-            "got@<11.8.5": ">=11.8.5",
-            "moment@>=2.18.0 <2.29.4": ">=2.29.4",
-            "ansi-regex@>=3.0.0 <3.0.1": ">=3.0.1",
-            "ansi-regex@>=4.0.0 <4.1.1": ">=4.1.1"
-        }
+        "access": "public",
+        "provenance": true
     }
 }

package/lib/postinstall.js DELETED Viewed

@@ -1,218 +0,0 @@
-#!/usr/bin/env node
-import { existsSync, writeFile } from "node:fs";
-import { join, resolve } from "node:path";
-import { promisify } from "node:util";
-// eslint-disable-next-line no-undef
-if (process.env.CI) {
-    // eslint-disable-next-line no-undef
-    process.exit(0);
-}
-const writeFileAsync = promisify(writeFile);
-// get the path to the host project.
-// eslint-disable-next-line no-undef
-const projectPath = resolve(process.cwd(), "..", "..", "..");
-console.log("Configuring @anolilab/textlint-config", projectPath, "\n");
-/**
- * Writes .textlintrc if it doesn't exist. Warns if it exists.
- */
-const writeTextlintRc = () => {
-    const eslintPath = join(projectPath, ".textlintrc");
-    const content = `{
-  "filters": {
-    "comments": true
-  },
-  "rules": {
-    "@textlint-rule/no-invalid-control-character": true,
-    "@textlint-rule/no-unmatched-pair": true,
-    "@textlint-rule/preset-google": true,
-    "abbr-within-parentheses": true,
-    "apostrophe": true,
-    "alex": {
-        "allow": [
-            "attack",
-            "european",
-            "execute"
-            "executed",
-            "execution",
-            "failure",
-            "fore",
-            "period",
-            "remain",
-        ]
-    },
-    "common-misspellings": true,
-    "date-weekday-mismatch": true
-    "diacritics": true,
-    "en-capitalization": true,
-    "footnote-order": true,
-    "no-dead-link": {
-        "ignore": [
-            "bc_data_*",
-        ]
-    },
-    "no-empty-section": true,
-    "no-todo": true,
-    "terminology": true,
-    "terminology": {
-      "defaultTerms": false,
-      "terms": [
-        // Abbreviations
-        "API",
-        ["API['’]?s", "APIs"],
-        "Ajax",
-        "CLI",
-        "CSS",
-        "CORS",
-        ["^E2E", "E2E"],
-        "gif",
-        ["^HTML", "HTML"],
-        ["^URL(s?)", "URL$1"],
-        ["^HTTP", "HTTP"],
-        ["^HTTPS", "HTTPS"],
-        "SSO",
-        ["^XHR(s?)", "XHR$1"],
-        ["^XHR['’]?s", "XHRs"],
-        "Xvfb",
-        "YAML",
-        // Words and phrases
-        ["\\\\(s\\\\)he", "they"],
-        ["he or she", "they"],
-        ["he/she", "they"],
-        ["crazy", "complex"],
-        ["crazier", "more complex"],
-        ["craziest", "most complex"],
-        ["dumb", "unintended"],
-        ["insane", "outrageous"],
-        // Prefer American spelling
-        ["behaviour", "behavior"],
-        ["cancelled", "canceled"],
-        ["cancelling", "canceling"],
-        ["centre", "center"],
-        ["colour", "color"],
-        ["customise", "customize"],
-        ["customisation", "customization"],
-        ["favourite", "favorite"],
-        ["labelled", "labeled"],
-        ["licence", "license"],
-        ["organise", "organize"],
-        // Common misspellings
-        ["gaurantee", "guarantee"],
-        // Words we would like to not use altogether
-        ["simply", ""],
-        // Single word
-        ["change[- ]log(s?)", "changelog$1"],
-        ["code[- ]base(es?)", "codebase$1"],
-        ["e[- ]mail(s?)", "email$1"],
-        ["end[- ]point(s?)", "endpoint$1"],
-        ["file[- ]name(s?)", "filename$1"],
-        ["can[- ]not", "cannot$1"],
-        // Multiple words
-        ["back-?end(s?)", "back end$1"],
-        ["front-?end(s?)", "front end$1"],
-        ["full-?stack(s?)", "full stack$1"],
-        ["open-?source(ed?)", "open source$1"],
-        ["web-?page(s?)", "web page$1"],
-        // Hyphenated
-        ["end ?to ?end", "end-to-end"],
-        ["retryability", "retry-ability"],
-        ["retriability", "retry-ability"],
-        ["some", ""],
-        ["filetype", "file type"],
-        ["stylesheet", "style sheet"],
-        ["like this", ""],
-        ["probably", ""],
-        ["known as", ""],
-        ["really", ""],
-        ["just", ""],
-        ["simple", ""],
-        ["obvious", ""],
-        ["straightforward", ""],
-        ["very", ""],
-        ["a little", ""],
-        ["note that", ""],
-        ["good to note", ""],
-        ["good to remember", ""],
-        ["basically", ""],
-        ["actually", ""],
-        ["pretty", ""],
-        ["easy", ""],
-        ["interesting", ""],
-        ["way to", ""],
-        ["In order to", "To"],
-        ["in order to", "to"],
-        ["might", ""],
-        ["us", ""],
-        ["I'll", ""],
-        ["I've", ""],
-        ["they'll", ""],
-        ["it is", "it's"],
-        ["It is", "It's"],
-      ]
-    },
-    "write-good": {
-      "passive": false,
-      "eprime": false,
-    }
-  }
-}
-`;
-    if (existsSync(eslintPath)) {
-        console.warn(`⚠️  .textlintrc already exists;
-Make sure that it includes the following for @anolilab/textlint-config'
-to work as it should: ${content}.`);
-        return Promise.resolve();
-    }
-    return writeFileAsync(eslintPath, content, "utf-8");
-};
-/**
- * Writes .textlintignore if it doesn't exist. Warns if it exists.
- */
-const writeTextlintIgnore = () => {
-    const eslintPath = join(projectPath, ".textlintignore");
-    const content = "";
-    if (existsSync(eslintPath)) {
-        console.warn("⚠️  .textlintignore already exists;");
-        return Promise.resolve();
-    }
-    return writeFileAsync(eslintPath, content, "utf-8");
-};
-// eslint-disable-next-line unicorn/prefer-top-level-await
-(async () => {
-    try {
-        await writeTextlintRc();
-        await writeTextlintIgnore();
-        console.log("😎  Everything went well, have fun!");
-        // eslint-disable-next-line no-undef
-        process.exit(0);
-    } catch (error) {
-        console.log("😬  something went wrong:");
-        console.error(error.message);
-        // eslint-disable-next-line no-undef
-        process.exit(1);
-    }
-})();