Skip to content

Commit

Permalink
feat(deps): upgrade to eslint@8 (#30)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: require ESLing 8 as peerDependencies

- migrate to TypeScript
- upgrade to ESLint 8
- change peerDependencies
  • Loading branch information
azu authored Dec 23, 2021
1 parent d0be346 commit 9c82606
Show file tree
Hide file tree
Showing 8 changed files with 773 additions and 507 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: test
on: [push, pull_request]
jobs:
test:
name: "Test on Node.js ${{ matrix.node-version }}"
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [ 14, 16 ]
steps:
- name: checkout
uses: actions/checkout@v2
- name: setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: Install
run: yarn install
- name: Test
run: yarn test
3 changes: 0 additions & 3 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# textlint-rule-eslint [![Build Status](https://travis-ci.org/textlint-rule/textlint-rule-eslint.svg?branch=master)](https://travis-ci.org/textlint-rule/textlint-rule-eslint) [![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)
# textlint-rule-eslint [![Actions Status: test](https://github.com/textlint-rule/textlint-rule-eslint.svg?branch=master)](https://travis-ci.org/textlint-rule/textlint-rule-eslint) [![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green/workflows/test/badge.svg)](https://github.com/textlint-rule/textlint-rule-eslint.svg?branch=master)](https://travis-ci.org/textlint-rule/textlint-rule-eslint) [![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green/actions?query=workflow%3A"test")


[textlint](https://textlint.github.io/ "textlint official site") rule to lint JavaScript in Markdown with ESLint.
Expand Down
12 changes: 9 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,21 @@
"textlint"
],
"devDependencies": {
"@types/eslint": "^8.2.1",
"@types/node": "^17.0.4",
"@types/structured-source": "^3.0.0",
"eslint": "7.28.0",
"eslint": "8.5.0",
"textlint-plugin-asciidoctor": "^1.1.0",
"textlint-scripts": "^12.1.0"
"textlint-scripts": "^12.1.0",
"ts-node": "^10.4.0",
"typescript": "^4.5.4",
"textlint-tester": "^12.1.0"
},
"peerDependencies": {
"eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
"eslint": "^8.0.0"
},
"dependencies": {
"@textlint/types": "^12.1.0",
"structured-source": "^3.0.2"
}
}
49 changes: 30 additions & 19 deletions src/textlint-rule-eslint.js → src/textlint-rule-eslint.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
// LICENSE : MIT
"use strict";
const path = require("path");
const Source = require("structured-source");
const CLIEngine = require("eslint").CLIEngine;
import path from "path";
import type { TextlintRuleContext, TextlintRuleModule } from "@textlint/types"
import Source from "structured-source";
import { ESLint } from "eslint";

const defaultOptions = {
// path to .eslintrc file
"configFile": null,
// recognize lang of CodeBlock
"langs": ["js", "javascript", "node", "jsx"]
};
const getConfigBaseDir = (context) => {
const getConfigBaseDir = (context: TextlintRuleContext & { config?: any }) => {
if (typeof context.getConfigBaseDir === "function") {
return context.getConfigBaseDir();
}
Expand All @@ -20,31 +22,40 @@ const getConfigBaseDir = (context) => {
return textlintRcFilePath ? path.dirname(textlintRcFilePath) : process.cwd();
};

const reporter = (context, options) => {
const { Syntax, RuleError, report, fixer, getSource } = context;
export type Options = {
configFile: string;
langs: string[]
}
const reporter: TextlintRuleModule<Options> = (context, options) => {
const { Syntax, RuleError, report, fixer, getSource, getFilePath} = context;
if (!options) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
if (!options.configFile) {
throw new Error(`Require options: { "configFile": "path/to/.eslintrc" }`);
}
const availableLang = options.langs || defaultOptions.langs;
const textlintRCDir = getConfigBaseDir(context);
const ESLintOptions = {
configFile: path.resolve(textlintRCDir, options.configFile)
};
const engine = new CLIEngine(ESLintOptions);
const esLintConfigFilePath = textlintRCDir ? path.resolve(textlintRCDir, options.configFile) : options.configFile;
const engine = new ESLint({
useEslintrc: false,
overrideConfigFile: esLintConfigFilePath
});
return {
[Syntax.CodeBlock](node) {
async [Syntax.CodeBlock](node) {
if (availableLang.indexOf(node.lang) === -1) {
return;
}
const raw = getSource(node);
const code = getUntrimmedCode(node, raw);
const source = new Source(code);
const resultLinting = engine.executeOnText(code, node.lang);
if (resultLinting.errorCount === 0) {
const resultLinting = await engine.lintText(code, {
filePath: `test.${node.lang}`
});
if (resultLinting.length === 0) {
return;
}
const results = resultLinting.results;
results.forEach(result => {
resultLinting.forEach(result => {
result.messages.forEach(message => {
/*
Expand All @@ -63,15 +74,15 @@ const reporter = (context, options) => {
const fixedRange = message.fix.range;
const fixedText = message.fix.text;
const sourceBlockDiffIndex = (raw !== node.value) ? raw.indexOf(code) : 0;
const fixedWithPadding = [fixedRange[0] + sourceBlockDiffIndex, fixedRange[1] + sourceBlockDiffIndex];
const fixedWithPadding = [fixedRange[0] + sourceBlockDiffIndex, fixedRange[1] + sourceBlockDiffIndex] as const;
const index = source.positionToIndex({
line: message.line,
column: message.column
});
const adjustedIndex = index + sourceBlockDiffIndex - 1;
report(node, new RuleError(`${prefix}${message.message}`, {
index: adjustedIndex,
fix: fixer.replaceTextRange(fixedWithPadding, fixedText)
fix: fixer.replaceTextRange(fixedWithPadding as [number, number], fixedText)
}));
} else {
const sourceBlockDiffIndex = (raw !== node.value) ? raw.indexOf(code) : 0;
Expand All @@ -97,7 +108,7 @@ const reporter = (context, options) => {
* @param {string} raw raw value include CodeBlock syntax
* @returns {string}
*/
function getUntrimmedCode(node, raw) {
function getUntrimmedCode(node: any, raw: string) {
if (node.type !== "CodeBlock") {
return node.value
}
Expand All @@ -123,7 +134,7 @@ function getUntrimmedCode(node, raw) {
return codeLines.join("\n") + "\n";
}

module.exports = {
export default {
linter: reporter,
fixer: reporter
};
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// LICENSE : MIT
"use strict";
import rule from "../src/textlint-rule-eslint";

const path = require("path");
import TextLintTester from "textlint-tester";
import path from "path";
const tester = new TextLintTester();
const configFilePath = path.join(__dirname, "fixtures/style.eslintconfig.js");
const WrongCode1 = "var a = 1";
const WrongCode2 = "var a = 1; var b = 2";
// @ts-expect-error
tester.run("textlint-rule-eslint", rule, {
valid: [
{
Expand Down
108 changes: 108 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016",
"noEmit": true,
/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "commonjs",
/* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true,
/* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true,
/* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true,
/* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true
/* Skip type checking all .d.ts files. */
}
}
Loading

0 comments on commit 9c82606

Please sign in to comment.