@alma-oss/remark-config 1.0.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.0-alpha.0 (2026-09-09)
+
+### ⚠ BREAKING CHANGES
+
+- **markdownlint:** Node.js v18 is now unsupported for this package. Use v20 or higher.
+- **markdownlint:** The package moved from the [@almacareer](https://github.com/almacareer) scope to [@alma-oss](https://github.com/alma-oss). Update your dependency to @alma-oss/remark-config.
+
+### Features
+
+- **markdownlint:** change library organization to alma-oss ([ebd47e5](https://github.com/lmc-eu/code-quality-tools/commit/ebd47e5726f25f34bcf2e53e152583e6df04932f))
+- **markdownlint:** drop support for Node.js v18 ([6c55524](https://github.com/lmc-eu/code-quality-tools/commit/6c5552407185a9199ba9c4bf062b565bf0d2ed8a))
+
+### Chores
+
+- **prettier:** Introduce package entrypoint through `exports` field ([8d63e20](https://github.com/lmc-eu/code-quality-tools/commit/8d63e20d43d027166903b983e262f7e94e515a3a))
+
+### Code Refactoring
+
+- **markdownlint:** use modern exports field instead of main ([f83865c](https://github.com/lmc-eu/code-quality-tools/commit/f83865cd228b6bd0ebff226cd7c8d11b8e23da0d))
+
+<a name="0.1.0"></a>
+
+# 0.1.0 (2024-08-07)
+
+### Features
+
+- **markdownlint:** Introducing remark-config package for linting Markdown files ([ac3a55f](https://github.com/lmc-eu/code-quality-tools/commit/ac3a55f)), closes [#12](https://github.com/lmc-eu/code-quality-tools/issues/12)
+
+**Note:** Version bump only for package @almacareer/remark-config

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, LMC s.r.o.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,23 @@
+# @alma-oss/remark-config
+
+> Alma Career’s config for [remark-cli][remark-cli-home]
+
+## Usage
+
+```sh
+npm i --dev remark-cli @alma-oss/remark-config
+```
+
+Now, create a _.remarkrc.js_ file in your project’s root with the following contents:
+
+```js
+import config from '@alma-oss/remark-config';
+
+export default {
+  ...config,
+};
+```
+
+Remark’s configuration does not support built-in extensibility/inheritance of configuration so if you’d like to change some configuration options you will have to resort to standard JavaScript’s object mutation/extension patterns.
+
+[remark-cli-home]: https://github.com/remarkjs/remark/tree/master/packages/remark-cli

package/index.js

@@ -0,0 +1,28 @@
+export default {
+  settings: {
+    emphasis: '_',
+  },
+
+  plugins: [
+    'preset-lint-recommended',
+    'preset-lint-consistent',
+    'preset-lint-markdown-style-guide',
+
+    // warn when the spacing between a list item’s bullet and its content violates a given style
+    // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-list-item-indent
+    ['lint-list-item-indent', 'one'],
+    // warn when lines are too long
+    // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-maximum-line-length
+    ['lint-maximum-line-length', Infinity],
+    // warn when emphasis markers violate the given style
+    // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-emphasis-marker
+    ['lint-emphasis-marker', '_'],
+    // warn when table pipes are not aligned
+    // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-table-pipe-alignment
+    ['lint-table-pipe-alignment', false],
+    // warn when table cells are incorrectly padded
+    // @see: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-table-cell-padding
+    ['lint-table-cell-padding', 'consistent'],
+    ['lint-no-undefined-references', { allow: ['x'] }],
+  ],
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@alma-oss/remark-config",
+  "description": "Alma Career's config for Markdown linting with Remark",
+  "version": "1.0.0-alpha.0",
+  "keywords": [
+    "config",
+    "lint",
+    "markdown",
+    "remark",
+    "alma",
+    "career"
+  ],
+  "author": "Tomáš Litera <tomas.litera@almacareer.com>",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/lmc-eu/code-quality-tools.git"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "remark-preset-lint-consistent": "^6.0.0",
+    "remark-preset-lint-markdown-style-guide": "^6.0.0",
+    "remark-preset-lint-recommended": "^7.0.0"
+  },
+  "gitHead": "e0813802528e9cd92fd6c6a835058ad067f2d958"
+}