@ivuorinen/markdownlint-config 1.3.11 → 2.0.0

package/README.md

@@ -24,7 +24,7 @@ npm install @ivuorinen/markdownlint-config --save-dev
 yarn add @ivuorinen/markdownlint-config --dev
 ```
 
-After installing it, a _`.markdownlint.json`_ file will be created automatically in the project's root folder with the following configuration:
+Create a _`.markdownlint.json`_ in the project's root folder with the following configuration:
 
 ```json
 {
@@ -32,13 +32,20 @@ After installing it, a _`.markdownlint.json`_ file will be created automatically
 }
 ```
 
+With npm, a `postinstall` script writes exactly this file when the project has no markdownlint config yet (npm 11
+warns that the script is not covered by `allowScripts`). Yarn 4 does not run dependency install scripts, so no file is
+written. pnpm refuses unapproved install scripts and fails the install until you allow this package with
+`pnpm approve-builds`. In both cases create the file by hand as above.
+
+Requires Node.js `^22.22.2 || ^24.15.0 || >=26`, the floor of the bundled `markdownlint-cli`.
+
 ## Documentation
 
 Read the [MarkdownLint docs][markdownlint-docs-link] for more information.
 
 ## Contributing
 
-If you are interested in helping contribute, please take a look at our [contribution guidelines][contributing-link] and open an [issue][issue-link] or [pull request][pull-request-link].
+If you are interested in helping contribute, please open an [issue][issue-link] or [pull request][pull-request-link].
 
 ## Changelog
 
@@ -51,7 +58,6 @@ Distributed under the MIT License. See [LICENSE][license-link] for more informat
 [changelog-link]: https://github.com/ivuorinen/base-configs-markdownlint/releases
 [markdownlint-docs-link]: https://github.com/DavidAnson/markdownlint
 [markdownlint-link]: https://github.com/DavidAnson/markdownlint
-[contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
 [issue-link]: https://github.com/ivuorinen/base-configs-markdownlint/issues
 [license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs-markdownlint?style=flat-square&labelColor=292a44&color=663399
 [license-link]: ./LICENSE.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ivuorinen/markdownlint-config",
-  "version": "1.3.11",
+  "version": "2.0.0",
   "type": "module",
   "description": "ivuorinen's shareable configuration for markdownlint.",
   "author": {
@@ -11,7 +11,7 @@
     "url": "https://github.com/ivuorinen/base-configs-markdownlint/issues"
   },
   "engines": {
-    "node": ">=20"
+    "node": "^22.22.2 || ^24.15.0 || >=26"
   },
   "files": [
     "index.json",
@@ -38,7 +38,7 @@
   },
   "scripts": {
     "postinstall": "node scripts/postinstall.cjs",
-    "test": "node -e \"JSON.parse(require('fs').readFileSync('./index.json', 'utf8')); console.log('index.json is valid JSON');\""
+    "test": "node -e \"JSON.parse(require('fs').readFileSync('./index.json', 'utf8')); console.log('index.json is valid JSON');\" && node --test"
   },
   "dependencies": {
     "@ivuorinen/config-checker": "^2.6.7",
@@ -46,7 +46,7 @@
   },
   "packageManager": "yarn@4.18.0",
   "devDependencies": {
-    "@ivuorinen/semantic-release-config": "^2.0.7"
+    "@ivuorinen/semantic-release-config": "^3.0.0"
   },
   "resolutions": {
     "minimatch": "^10.2.4",

package/scripts/postinstall.cjs

@@ -7,7 +7,14 @@ const path = require("node:path");
 // noinspection NpmUsedModulesInstalled
 const process = require("node:process");
 const checkConfig = require("@ivuorinen/config-checker");
-const foundConfig = checkConfig("markdownlint");
+
+// This runs on every consumer install, and a non-zero exit fails that whole
+// install. The starter config is a convenience, so every step below degrades to
+// a message instead of throwing.
+
+// INIT_CWD is an npm/yarn convention, not a guarantee.
+const cwd = process.env.INIT_CWD || process.cwd();
+const foundConfig = checkConfig("markdownlint", cwd);
 
 if (foundConfig.length > 0) {
   console.log("markdownlint-config: Found existing markdownlint config file, skipping creation.");
@@ -16,11 +23,18 @@ if (foundConfig.length > 0) {
   process.exit(0);
 }
 
-const filePath = path.join(process.env.INIT_CWD, ".markdownlint.json");
+const filePath = path.join(cwd, ".markdownlint.json");
 const fileConfigObject = {
   extends: "@ivuorinen/markdownlint-config",
 };
 
-if (!fs.existsSync(filePath)) {
-  fs.writeFileSync(filePath, JSON.stringify(fileConfigObject, undefined, 2));
+// "wx" makes "does it exist?" and "write it" one atomic step, so a concurrent
+// install cannot create the file in between and have it overwritten.
+try {
+  fs.writeFileSync(filePath, JSON.stringify(fileConfigObject, undefined, 2), { flag: "wx" });
+} catch (error) {
+  if (error.code !== "EEXIST") {
+    console.log(`markdownlint-config: could not write ${filePath} (${error.code || error.message}).`);
+    console.log(`markdownlint-config: create it manually with ${JSON.stringify(fileConfigObject)}`);
+  }
 }