linted


> [!CAUTION]
> ___DO NOT USE - DOCUMENTATION IS SIGNIFICANTLY OUTDATED AS OF AUGUST 4, 2024___

---

ESLint mono-plugin bundler with strict, opinionated defaults for JavaScript, TypeScript, Svelte, HTML, Tailwind/CSS, JSON, JSONC, YAML, and Mocha.

1. Languages
2. Features
3. Limitation
4. Install
5. Roadmap
6. Rule Logic (Advanced)

Languages

$3

> [!NOTE]
> _See language support __roadmap.___

- __JavaScript:__ eslint
- __TypeScript:__ @typescript-eslint + eslint
- __Svelte:__ eslint-plugin-svelte + @typescript-eslint + eslint
- __HTML:__ @html-eslint

$3

- __JSON & JSONC:__ eslint-plugin-jsonc
- __YAML:__ eslint-plugin-yml

Features

$3

No need to install 17 plugins and 12 parsers: each language's latest plugin is bundled and configured.

$3

No need to remember each plugin's parserOptions; you won't have to do _this_ just to enable Svelte linting:

``javascript
// lint TypeScript blocks in Svelte
plugins: {
"@typescript-eslint": ts,
svelte,
},
languageOptions: {
ecmaVersion: "latest",
sourceType: "module",
parser: svelteParser,
parserOptions: {
parser: tsParser,
ecmaVersion: "latest",
sourceType: "module",
project: "tsconfig.json",
extraFileExtensions: [".svelte"],
},
},
processor: "svelte/svelte",
`

$3

`javascript
linted();
`

$3

`javascript
import linted from "linted";

export default linted();
`

$3

- includes (scoped glob patterns)
- ignores (global glob patterns and other options)
- overrides (scoped rule statements)

#### includes _(Scoped)_

`javascript
import linted from "linted";

linted(
{
/ includes /
js: [
"scripts/*//.{js,mjs}",
"*.config.js",
], / example: array of glob patterns to lint using JavaScript rules /
ts: [
"src/*/.ts",
"*.config.ts",
],
// svelte: [],
// html: [],

/ ...json, jsonc, yml, /
},
);
`

#### ignores _(Global)_

`javascript
import linted from "linted";

linted(
{ / includes / },
{
/ ignores /
gitignore: true, / (default) never lint any git-ignored file /
ignoreArtifacts: true, / (default) never lint "//package-lock.json" */
global: [], / array of glob patterns to never lint /
},
)
`

#### overrides _(Scoped)_

`javascript
linted(
{/ includes /},
{/ ignores /},
{
/ overrides /
overrideJs: {}, / js rule overrides /
overrideTs: {
/* Overrides apply to ts scope,
* but NOT to js scope,
* NOR to svelte scope.
*/
"no-unused-vars": "off", / example: ESLint base rule /
"@typescript-eslint/indent": "warn", / example: TypeScript plugin rule /
}, / js rule overrides /
/ ...overrideTs, overrideSvelte, overrideHtml, overrideJson, overrideJsonc, overrideYml, /
},
);
`

Limitation

In __TypeScript__ projects, skipLibCheck must be true.

$3

By default, skipLibCheck is false. To set it to true:

#### tsconfig.json

`jsonc
{
"compilerOptions": {
"skipLibCheck": true,
},
}
`

#### _...or_ tsc CLI option

`bash
tsc --skipLibCheck
`

Install

1. Install eslint and linted.

`bash
npm i -D eslint@^8.57 linted
`

1. Create eslint.config.js in your project root.

1. In eslint.config.js:
- Import function linted.

`javascript
import linted from "linted";
`

- Export linted with optional arguments:

`javascript
import linted from "linted";

export default linted(
// ...
);
`

---

Roadmap

$3

#### Tailwind

- Tailwind

- CSS

#### HTML Embeds

- Embedded TypeScript

- Embedded CSS

- Svelte Interaction TBD

- .svelte-embedded HTML (on top of Svelte HTML rules)

- .html files in Svelte projects (e.g. title not required)

- Should Svelte-Linter handle all .html / HTML-embedded linting for Svelte projects, and HTML-Linter only handles non-Svelte projects?

#### JSON (Custom Schema Validation)

- JSON Custom Schema Validation

---

Rule Logic (Advanced)

$3

Each scope maps to a unique language:

- __js:__ JavaScript
- __ts:__ TypeScript
- __svelte:__ Svelte
- __html:__ HTML
- __json:__ JSON
- __jsonc:__ JSONC
- __yml:__ YAML

$3

Each scope supports:

- all base ESLint rules
- all rules from its language's __plugins__

#### Default Rules

- Each language has a set of default rules.

#### Language-Aggregate scope

A language can be an extension of or depend on another language.

For example:

- TypeScript extends JavaScript
- Svelte depends on TypeScript (which extends JavaScript)

For such a language, its scope's default rules are aggregated with the default rules of extended or consumed languages by scope precedence:

- __js:__ js
- __ts:__ js < ts
- __svelte:__ js < ts < svelte
- __html:__ html
- __json:__ json
- __jsonc:__ json < jsonc
- __yml:__ yml

$3

#### Global Ignores

##### .gitignore

By default, linted ignores all files in .gitignore. This behavior can be disabled.

##### package-lock.json

*/.package-lock.json is always skipped. _This cannot be overriden._

##### ignores

Additional glob patterns supplied if matched by a file will skip linting that file, even if a scope pattern matches the file.

#### Scoped Includes

Files specified in scope are appended to the following default files:

`javascript
{
js: [
"{src,static}/*/.{js,mjs,cjs}",
"*.{js,mjs,cjs}",
],
ts: [
"{src,static}/*/.{ts,mts,cts}",
"*.{ts,mts,cts}",
],
svelte: ["{src,static}/*/.svelte"],
html: [
"{src,static}/*/.html",
"*.html",
],
json: [
"{src,static}/*/.json",
"*.json",
],
jsonc: [
"tsconfig.json",
"{src,static}/*/.jsonc",
"*.jsonc",
],
yml: [
".github/workflows/*.{yml,yaml}",
"{src,static}/*/.{yml,yaml}",
"*.{yml,yaml}",
],
},
`

#### Scope Conflict

- If a given file matches more than one scope glob, then the set of all matching scopes' rules are applied to the file.
- If any rule is specified in more than one scope matching a given file, the specifies a rule, then the highest-precedence scope's rule specification wins.

##### Scope Precedence (low to high)

`bash
js
ts
svelte
html
json
jsonc
yml
ignores (global)
`

$3

Overrides are per-__scope.__

#### Example

overrideTs rules apply to files which:

- ✅ ONLY match scope ts.
- ✅ match scope ts and any number of lower precedence scopes (e.g. js).
> [!NOTE]
> overrideTs rules do __NOT__ apply to files which:
>
> - TBD
- ❌ match scope ts and at least one higher precedence scope (e.g. svelte), even if the higher precedence scope includes ts language default rules (e.g. svelte includes ts default rules, but NOT overrideTs` rules).