refactor: use union @1stg/lib-config to simplify devDependencies

JounQin · JounQin · commit 96fc83affd7f · 2019-11-03T20:31:31.000+08:00
diff --git a/.eslintcache b/.eslintcache
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -11,11 +11,6 @@ tsNode.register({
 module.exports = {
   root: true,
   extends: ['@1stg/eslint-config/recommended'],
-  settings: {
-    node: {
-      allowModules: ['@babel/types', 'estree', 'unist'],
-    },
-  },
   rules: {
     '@typescript-eslint/no-unnecessary-condition': 0,
     '@typescript-eslint/unbound-method': 0, // See https://github.com/typescript-eslint/typescript-eslint/issues/636
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 *.log
 *.tsbuildinfo
+.*cache
 .changelog
 .type-coverage
 coverage
diff --git a/.travis.yml b/.travis.yml
@@ -34,7 +34,8 @@ before_deploy:
   - cp -f README.md packages/eslint-mdx
   - cp -f README.md packages/eslint-plugin-mdx
   - 'git add --all && git commit -m "docs: update README" || echo "nothing changed to commit"'
-  - yarn lerna-changelog
+  - yarn global add lerna-changelog
+  - lerna-changelog
 
 deploy:
   - provider: script
diff --git a/package.json b/package.json
@@ -24,44 +24,28 @@
     "type-coverage": "type-coverage --cache --detail --ignore-catch --ignore-files *.d.ts --strict"
   },
   "devDependencies": {
-    "@1stg/babel-preset": "^0.7.10",
-    "@1stg/commitlint-config": "^0.1.2",
-    "@1stg/eslint-config": "^0.13.2",
-    "@1stg/husky-config": "^0.3.2",
-    "@1stg/lint-staged": "^0.8.11",
-    "@1stg/prettier-config": "^0.4.3",
-    "@1stg/remark-config": "^0.2.2",
-    "@1stg/tsconfig": "^0.6.1",
-    "@1stg/tslint-config": "^0.4.4",
-    "@babel/core": "^7.6.4",
-    "@commitlint/cli": "^8.2.0",
-    "@pkgr/rollup": "^0.3.0",
+    "@1stg/lib-config": "^0.1.6",
+    "@1stg/tslint-config": "^0.5.5",
     "@types/cosmiconfig": "^5.0.3",
-    "@types/eslint": "^6.1.2",
-    "@types/jest": "^24.0.19",
-    "@types/node": "^12.11.5",
-    "@types/react": "^16.9.9",
+    "@types/eslint": "^6.1.3",
+    "@types/jest": "^24.0.21",
+    "@types/node": "^12.12.5",
+    "@types/react": "^16.9.11",
     "@types/rebass": "^4.0.3",
     "@types/unist": "^2.0.3",
-    "eslint": "^6.5.1",
     "eslint-mdx": "link:packages/eslint-mdx/src",
     "eslint-plugin-mdx": "link:packages/eslint-plugin-mdx/src",
-    "husky": "^3.0.9",
-    "jest": "^24.9.0",
     "lerna": "^3.18.3",
-    "lerna-changelog": "^0.8.2",
-    "lint-staged": "^9.4.2",
     "npm-run-all": "^4.1.5",
-    "prettier": "1.18.2",
     "react": "^16.11.0",
-    "rollup": "^1.25.1",
     "ts-jest": "^24.1.0",
     "ts-node": "^8.4.1",
     "tslint": "^5.20.0",
     "type-coverage": "^2.3.0",
     "typescript": "^3.6.4"
   },
   "resolutions": {
+    "@babel/core": "^7.6.4",
     "typescript": "^3.6.4"
   },
   "commitlint": {
diff --git a/packages/eslint-mdx/src/helper.ts b/packages/eslint-mdx/src/helper.ts
@@ -2,8 +2,6 @@
 
 import { AST, Linter } from 'eslint'
 import { parse as esParse } from 'espree'
-import { SourceLocation } from 'estree'
-import { Position } from 'unist'
 
 import {
   Arrayable,
@@ -24,6 +22,7 @@ export const JSX_TYPES: JsxTypes = ['JSXElement', 'JSXFragment']
 export const isJsxNode = (node: { type: string }): node is JsxNode =>
   JSX_TYPES.includes(node.type as JsxType)
 
+// eslint-disable-next-line sonarjs/cognitive-complexity
 export const normalizeParser = (parser?: ParserOptions['parser']) => {
   if (parser) {
     if (typeof parser === 'string') {
@@ -68,7 +67,7 @@ export const normalizeParser = (parser?: ParserOptions['parser']) => {
 }
 
 export const normalizePosition = (
-  position: Position,
+  position: import('unist').Position,
 ): Pick<AST.Program, 'loc' | 'range'> & {
   start: number
   end: number
@@ -87,7 +86,7 @@ export const normalizePosition = (
 
 export interface BaseNode {
   type: string
-  loc?: SourceLocation
+  loc?: import('estree').SourceLocation
   range?: [number, number]
 }
 
diff --git a/packages/eslint-mdx/src/parser.ts b/packages/eslint-mdx/src/parser.ts
@@ -1,10 +1,9 @@
-import { AST, Linter } from 'eslint'
-import { ExpressionStatement } from 'estree'
 import path from 'path'
+
+import { AST, Linter } from 'eslint'
 import remarkMdx from 'remark-mdx'
 import remarkParse from 'remark-parse'
 import unified from 'unified'
-import { Node, Parent } from 'unist'
 
 import {
   hasProperties,
@@ -16,7 +15,14 @@ import {
 } from './helper'
 import { COMMENT_CONTENT_REGEX, isComment } from './regexp'
 import { traverse } from './traverse'
-import { Comment, LocationError, ParserFn, ParserOptions } from './types'
+import {
+  Comment,
+  LocationError,
+  Node,
+  Parent,
+  ParserFn,
+  ParserOptions,
+} from './types'
 
 export const mdxProcessor = unified()
   .use(remarkParse)
@@ -225,6 +231,7 @@ export class Parser {
 
   // fix adjacent JSX nodes
   // @internal
+  // eslint-disable-next-line sonarjs/cognitive-complexity
   private _normalizeJsxNodes(
     node: Node,
     options: ParserOptions,
@@ -257,7 +264,8 @@ export class Parser {
       return node
     }
 
-    const { expression } = program.body[0] as ExpressionStatement
+    const { expression } = program
+      .body[0] as import('estree').ExpressionStatement
 
     if (!isJsxNode(expression) || expression.children.length <= 1) {
       return node
diff --git a/packages/eslint-mdx/src/traverse.ts b/packages/eslint-mdx/src/traverse.ts
@@ -1,5 +1,3 @@
-import { Node, Parent } from 'unist'
-
 import { last } from './helper'
 import {
   isCloseTag,
@@ -8,7 +6,7 @@ import {
   isOpenTag,
   isSelfClosingTag,
 } from './regexp'
-import { TraverseOptions, Traverser } from './types'
+import { Node, Parent, TraverseOptions, Traverser } from './types'
 
 export class Traverse {
   // @internal
@@ -35,6 +33,7 @@ export class Traverse {
     let offset = 0
     const jsxNodes: Node[] = []
     const { length } = nodes
+    // eslint-disable-next-line sonarjs/cognitive-complexity
     return nodes.reduce<Node[]>((acc, node, index) => {
       if (node.type === 'jsx') {
         const value = node.value as string
diff --git a/packages/eslint-mdx/src/types.ts b/packages/eslint-mdx/src/types.ts
@@ -1,16 +1,18 @@
-import { JSXElement, JSXFragment } from '@babel/types'
+/* eslint-disable @typescript-eslint/no-type-alias */
 import { AST, Linter } from 'eslint'
-import { Node, Parent, Point } from 'unist'
+
+export type JSXElement = import('@babel/types').JSXElement
+export type JSXFragment = import('@babel/types').JSXFragment
+export type Node = import('unist').Node
+export type Parent = import('unist').Parent
+export type Point = import('unist').Point
 
 export type JsxNode = (JSXElement | JSXFragment) & { range: [number, number] }
 
-// eslint-disable-next-line @typescript-eslint/no-type-alias
 export type JsxTypes = Readonly<[JSXElement['type'], JSXFragment['type']]>
 
-// eslint-disable-next-line @typescript-eslint/no-type-alias
 export type JsxType = JsxTypes[number]
 
-// eslint-disable-next-line @typescript-eslint/no-type-alias
 export type Arrayable<T> = T[] | readonly T[]
 
 export type ParserFn = (
diff --git a/packages/eslint-plugin-mdx/package.json b/packages/eslint-plugin-mdx/package.json
@@ -40,6 +40,6 @@
     "vfile": "^4.0.1"
   },
   "optionalDependencies": {
-    "rebass": "^4.0.6"
+    "rebass": "^4.0.7"
   }
 }
diff --git a/packages/eslint-plugin-mdx/src/rules/helper.ts b/packages/eslint-plugin-mdx/src/rules/helper.ts
@@ -1,5 +1,6 @@
-import cosmiconfig, { CosmiconfigResult, Explorer } from 'cosmiconfig'
 import path from 'path'
+
+import cosmiconfig, { CosmiconfigResult, Explorer } from 'cosmiconfig'
 import remarkMdx from 'remark-mdx'
 import remarkParse from 'remark-parse'
 import remarkStringify from 'remark-stringify'
diff --git a/packages/eslint-plugin-mdx/src/rules/no-jsx-html-comments.ts b/packages/eslint-plugin-mdx/src/rules/no-jsx-html-comments.ts
@@ -1,6 +1,5 @@
 import { Rule } from 'eslint'
 import { Comment, JSX_TYPES, JsxType } from 'eslint-mdx'
-import { Node } from 'unist'
 
 import { ExpressionStatementWithParent } from './types'
 
@@ -21,7 +20,7 @@ export const noJsxHtmlComments: Rule.RuleModule = {
   create(context) {
     return {
       ExpressionStatement(node: ExpressionStatementWithParent) {
-        const invalidNodes: Node[] =
+        const invalidNodes: Array<import('unist').Node> =
           context.parserServices.JSXElementsWithHTMLComments
 
         if (
diff --git a/packages/eslint-plugin-mdx/src/rules/no-unescaped-entities.ts b/packages/eslint-plugin-mdx/src/rules/no-unescaped-entities.ts
@@ -41,6 +41,7 @@ export const noUnescapedEntities: Rule.RuleModule = {
     const configuration = context.options[0] || {}
     const entities: EscapeEntity[] = configuration.forbid || DEFAULTS
     return {
+      // eslint-disable-next-line sonarjs/cognitive-complexity
       [EXPRESSION](node: NodeWithParent) {
         let { parent } = node
 
@@ -108,7 +109,7 @@ export const noUnescapedEntities: Rule.RuleModule = {
                   message: `\`${
                     entity.char
                   }\` can be escaped with ${entity.alternatives
-                    .map(alt => `\`${alt}\``)
+                    .map(alt => '``'.split('').join(alt))
                     .join(', ')}.`,
                   node,
                 })
diff --git a/packages/eslint-plugin-mdx/src/rules/remark.ts b/packages/eslint-plugin-mdx/src/rules/remark.ts
@@ -1,6 +1,7 @@
+import path from 'path'
+
 import { Rule } from 'eslint'
 import { DEFAULT_EXTENSIONS, MARKDOWN_EXTENSIONS } from 'eslint-mdx'
-import path from 'path'
 import vfile from 'vfile'
 
 import { getRemarkProcessor } from './helper'
diff --git a/packages/eslint-plugin-mdx/src/rules/types.ts b/packages/eslint-plugin-mdx/src/rules/types.ts
@@ -1,3 +1,4 @@
+// eslint-disable-next-line node/no-extraneous-import
 import { ExpressionStatement, Node } from 'estree'
 import { Attacher } from 'unified'
 
diff --git a/test/fixtures.test.ts b/test/fixtures.test.ts
@@ -1,7 +1,8 @@
-import { CLIEngine } from 'eslint'
 import { basename } from 'path'
 
-export const cli = new CLIEngine({
+import { CLIEngine } from 'eslint'
+
+const cli = new CLIEngine({
   ignore: false,
   fix: true,
 })
diff --git a/test/helper.test.ts b/test/helper.test.ts
@@ -1,6 +1,7 @@
-import { getGlobals, requirePkg } from 'eslint-plugin-mdx'
 import path from 'path'
 
+import { getGlobals, requirePkg } from 'eslint-plugin-mdx'
+
 describe('Helpers', () => {
   it('should resolve globals correctly', () => {
     expect(getGlobals({})).toEqual({})
diff --git a/test/parser.test.ts b/test/parser.test.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,6 @@`
`40`	`40`	`"vfile": "^4.0.1"`
`41`	`41`	`},`
`42`	`42`	`"optionalDependencies": {`
`43`		`- "rebass": "^4.0.6"`
	`43`	`+ "rebass": "^4.0.7"`
`44`	`44`	`}`
`45`	`45`	`}`