eslint-plugin-frontmatter2 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+<!-- markdownlint-disable -->
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v1.0.0] - 2024-04-15
+
+Initial Release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Chris Zuber
+
+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,63 @@
+# eslint-plugin-frontmatter2
+
+Plugin to allow YAML frontmatter to be ignored by ESLint
+
+[![CodeQL](https://github.com/shgysk8zer0/eslint-frontmatter/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/eslint-frontmatter/actions/workflows/codeql-analysis.yml)
+![Node CI](https://github.com/shgysk8zer0/eslint-frontmatter/workflows/Node%20CI/badge.svg)
+![Lint Code Base](https://github.com/shgysk8zer0/eslint-frontmatter/workflows/Lint%20Code%20Base/badge.svg)
+
+[![GitHub license](https://img.shields.io/github/license/shgysk8zer0/eslint-frontmatter.svg)](https://github.com/shgysk8zer0/eslint-frontmatter/blob/master/LICENSE)
+[![GitHub last commit](https://img.shields.io/github/last-commit/shgysk8zer0/eslint-frontmatter.svg)](https://github.com/shgysk8zer0/eslint-frontmatter/commits/master)
+[![GitHub release](https://img.shields.io/github/release/shgysk8zer0/eslint-frontmatter?logo=github)](https://github.com/shgysk8zer0/eslint-frontmatter/releases)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)
+
+[![npm](https://img.shields.io/npm/v/eslint-plugin-frontmatter2)](https://www.npmjs.com/package/eslint-plugin-frontmatter2)
+![node-current](https://img.shields.io/node/v/eslint-plugin-frontmatter2)
+![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/eslint-plugin-frontmatter2)
+[![npm](https://img.shields.io/npm/dw/eslint-plugin-frontmatter2?logo=npm)](https://www.npmjs.com/package/eslint-plugin-frontmatter2)
+
+[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)
+![GitHub forks](https://img.shields.io/github/forks/shgysk8zer0/eslint-frontmatter.svg?style=social)
+![GitHub stars](https://img.shields.io/github/stars/shgysk8zer0/eslint-frontmatter.svg?style=social)
+[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)
+
+[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")
+- - -
+
+- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
+- [Contributing](./.github/CONTRIBUTING.md)
+<!-- - [Security Policy](./.github/SECURITY.md) -->
+
+```js
+---
+foo: bar
+number: 42
+works: true
+person:
+  name: Chris
+  age: 38
+  developer: true
+---
+
+console.log('{{ foo }}');
+console.log(JSON.parse('{{ person | jsonify }}'));
+```
+
+> [!IMPORTANT]
+> This plugin does not enable Liquid templating support in JavaScript. For this
+> reason, it is advised that you enclose all such variables in quotes and treat
+> them as strings, eg. `foo('{{ bar }}')`. You may use `parseInt` or `JSON.parse`
+> as necessary from there.
+
+## Example Config File
+
+```js
+import frontmatter from 'eslint-plugin-frontmatter2';
+
+export default {
+  'plugins': {
+    'frontmatter2': frontmatter
+  },
+  processor: 'frontmatter/frontmatter',
+};
+```

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "eslint-plugin-frontmatter2",
+  "version": "1.0.0",
+  "description": "Plugin to allow YAML frontmatter to be ignored by ESLint",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "eslint-frontmatter",
+    "eslint-plugin-frontmatter",
+    "frontmatter",
+    "jekyll",
+    "liguid",
+    "eleventy",
+    "11ty"
+  ],
+  "type": "module",
+  "main": "./plugin.cjs",
+  "module": "./plugin.mjs",
+  "exports": {
+    ".": {
+      "import": "./plugin.mjs",
+      "require": "./plugin.cjs"
+    },
+    "./*.js": {
+      "import": "./*.mjs",
+      "require": "./*.cjs"
+    },
+    "./*.mjs": {
+      "import": "./*.mjs",
+      "require": "./*.cjs"
+    },
+    "./*.cjs": {
+      "import": "./*.mjs",
+      "require": "./*.cjs"
+    },
+    "./*": {
+      "import": "./*.mjs",
+      "require": "./*.cjs"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "private": false,
+  "scripts": {
+    "test": "npm run lint:js && npm run build",
+    "preversion": "npm test",
+    "prepare": "npm run build",
+    "lint:js": "eslint .",
+    "fix:js": "eslint . --fix",
+    "build": "npm run build:js",
+    "clean": "rm -f ./*.cjs && rm -f ./*.mjs",
+    "build:js": "npm run clean && rollup -c rollup.config.js",
+    "create:lock": "npm i --package-lock-only --ignore-scripts --no-audit --no-fund",
+    "version:bump": "npm run version:bump:patch",
+    "version:bump:patch": "npm version --no-git-tag-version patch && npm run create:lock",
+    "version:bump:minor": "npm version --no-git-tag-version minor && npm run create:lock",
+    "version:bump:major": "npm version --no-git-tag-version major && npm run create:lock"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shgysk8zer0/eslint-frontmatter.git"
+  },
+  "author": "Chris Zuber <admin@kernvalley.us>",
+  "license": "MIT",
+  "funding": [
+    {
+      "type": "librepay",
+      "url": "https://liberapay.com/shgysk8zer0"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/shgysk8zer0"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/shgysk8zer0/eslint-frontmatter/issues"
+  },
+  "homepage": "https://github.com/shgysk8zer0/eslint-frontmatter#readme",
+  "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
+    "eslint": "^9.0.0",
+    "rollup": "^4.14.3"
+  }
+}

package/plugin.cjs

@@ -0,0 +1,65 @@
+'use strict';
+
+var name = "eslint-plugin-frontmatter2";
+var version = "1.0.0";
+
+// Import from module since import attributes not yet supported
+
+const map = new Map();
+
+/**
+ * @see https://eslint.org/docs/latest/extend/custom-processors#custom-processor-specification
+ */
+const frontmatter = {
+	meta: { name, version },
+	processors: {
+		'frontmatter': {
+			meta: {
+				// Must begin with 'eslint-'
+				name: 'eslint-frontmatter',
+				version,
+			},
+
+			/**
+			 * Strips out frontmatter before linting
+			 */
+			preprocess(text, filename) {
+				if (text.startsWith('---')) {
+					// Trim out opening of frontmatter ('---\n')
+					const trimmed = text.substring(4);
+					// Find index of closing of frontmatter & add 4 for '---\n'
+					const end = trimmed.search(/^---$/m) + 4;
+
+					if (end > 3) {
+						// Count number of newlines in frontmatter section
+						const newlines = text.substring(0, end).match(/[\r\n]{1}/g);
+						// Save number of newlines for `postprocess`
+						map.set(filename, newlines.length + 1);
+						return [{ text: trimmed.substring(end), filename }];
+					} else {
+						return [{ text, filename }];
+					}
+				} else {
+					return [{ text, filename }];
+				}
+			},
+
+			/**
+			 * Adjust line numbers in errors to correct for stripped frontmatter
+			 */
+			postprocess(messages, filename) {
+				if (map.has(filename)) {
+					const offset = map.get(filename);
+					return messages.flatMap(
+						errs => errs.map(({ line, ...rest }) => ({ line: line + offset, ...rest}))
+					);
+				} else {
+					return messages.flat();
+				}
+			},
+			supportsAutofix: false,
+		}
+	}
+};
+
+exports.frontmatter = frontmatter;

package/plugin.mjs

@@ -0,0 +1,63 @@
+var name = "eslint-plugin-frontmatter2";
+var version = "1.0.0";
+
+// Import from module since import attributes not yet supported
+
+const map = new Map();
+
+/**
+ * @see https://eslint.org/docs/latest/extend/custom-processors#custom-processor-specification
+ */
+const frontmatter = {
+	meta: { name, version },
+	processors: {
+		'frontmatter': {
+			meta: {
+				// Must begin with 'eslint-'
+				name: 'eslint-frontmatter',
+				version,
+			},
+
+			/**
+			 * Strips out frontmatter before linting
+			 */
+			preprocess(text, filename) {
+				if (text.startsWith('---')) {
+					// Trim out opening of frontmatter ('---\n')
+					const trimmed = text.substring(4);
+					// Find index of closing of frontmatter & add 4 for '---\n'
+					const end = trimmed.search(/^---$/m) + 4;
+
+					if (end > 3) {
+						// Count number of newlines in frontmatter section
+						const newlines = text.substring(0, end).match(/[\r\n]{1}/g);
+						// Save number of newlines for `postprocess`
+						map.set(filename, newlines.length + 1);
+						return [{ text: trimmed.substring(end), filename }];
+					} else {
+						return [{ text, filename }];
+					}
+				} else {
+					return [{ text, filename }];
+				}
+			},
+
+			/**
+			 * Adjust line numbers in errors to correct for stripped frontmatter
+			 */
+			postprocess(messages, filename) {
+				if (map.has(filename)) {
+					const offset = map.get(filename);
+					return messages.flatMap(
+						errs => errs.map(({ line, ...rest }) => ({ line: line + offset, ...rest}))
+					);
+				} else {
+					return messages.flat();
+				}
+			},
+			supportsAutofix: false,
+		}
+	}
+};
+
+export { frontmatter };