@ivuorinen/markdownlint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ismo Vuorinen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# @ivuorinen/markdownlint-config <!-- omit in toc -->
+
+[![npm package][npm-badge]][npm-link]
+[![license MIT][license-badge]][license-link]
+[![code style][style-badge]][style-link]
+
+> ivuorinen's shareable configuration for [`MarkdownLint`][markdownlint-link].
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+- [Documentations](#documentations)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+- [License](#license)
+
+## Installation
+
+Install `this config` as a _`devDependencies`_:
+
+```sh
+# npm
+npm install @ivuorinen/markdownlint-config --save-dev
+
+# Yarn
+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:
+
+```json
+{
+  "extends": "@ivuorinen/markdownlint-config"
+}
+```
+
+## Documentations
+
+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].
+
+## Changelog
+
+See [CHANGELOG][changelog-link] for a human-readable history of changes.
+
+## License
+
+Distributed under the MIT License. See [LICENSE][license-link] for more information.
+
+[changelog-link]: ./CHANGELOG.md
+[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/issues
+[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
+[license-link]: ./LICENSE
+[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/markdownlint-config?style=flat-square&labelColor=292a44&color=663399
+[npm-link]: https://www.npmjs.com/package/@ivuorinen/markdownlint-config
+[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
+[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square
+[style-link]: https://github.com/ivuorinen/base-configs

package/index.json

@@ -0,0 +1,5 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD033": false
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@ivuorinen/markdownlint-config",
+  "version": "0.1.0",
+  "description": "ivuorinen's shareable configuration for markdownlint.",
+  "author": {
+    "name": "Ismo Vuorinen",
+    "url": "https://github.com/ivuorinen"
+  },
+  "bugs": {
+    "url": "https://github.com/ivuorinen/base-configs/issues"
+  },
+  "engines": {
+    "node": ">= 12",
+    "npm": ">= 6",
+    "yarn": ">=1.20.0"
+  },
+  "files": [
+    "index.json",
+    "scripts/*"
+  ],
+  "homepage": "https://github.com/ivuorinen/base-configs/tree/main/packages/markdownlint-config#readme",
+  "keywords": [
+    "markdownlint-config",
+    "markdownlint",
+    "config",
+    "ivuorinen"
+  ],
+  "license": "MIT",
+  "main": "index.json",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ivuorinen/base-configs.git"
+  },
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "dependencies": {
+    "markdownlint-cli": "0.32.2"
+  },
+  "gitHead": "0b2b89ca98caac7995c4c2a3662f0d338043938b"
+}

package/scripts/postinstall.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+
+const filePath = path.join(process.env.INIT_CWD, '.markdownlint.json')
+
+const fileConfigObject = {
+  extends: '@ivuorinen/markdownlint-config'
+}
+
+if (!fs.existsSync(filePath)) {
+  fs.writeFileSync(filePath, JSON.stringify(fileConfigObject, undefined, 2))
+}