fix: react could be unavailable, add hardcoded component names to… (#70)

Author: JounQin

.gitignore

@@ -1,8 +1,7 @@
 *.log
+*.tsbuildinfo
 .changelog
 .type-coverage
 coverage
 lib
 node_modules
-tsconfig.tsbuildinfo
-test.*

.travis.yml

@@ -23,8 +23,9 @@ script:
   - yarn test
 
 after_success:
-  - yarn global add codecov
+  - yarn global add codecov codacy-coverage
   - codecov
+  - cat ./coverage/lcov.info | codacy-coverage
 
 before_deploy:
   - npm set //registry.npmjs.org/:_authToken $NPM_TOKEN
@@ -49,6 +50,5 @@ deploy:
       branch: develop
 
 after_script:
-  - yarn add -D @codechecks/client @codechecks/build-size-watcher @codechecks/type-coverage-watcher codacy-coverage -W
+  - yarn add -D @codechecks/client @codechecks/build-size-watcher @codechecks/type-coverage-watcher -W
   - yarn codechecks
-  - cat ./coverage/lcov.info | yarn codacy-coverage

package.json

@@ -41,7 +41,7 @@
     "jest": "^24.9.0",
     "lerna": "^3.16.4",
     "lerna-changelog": "^0.8.2",
-    "lint-staged": "^9.2.5",
+    "lint-staged": "^9.3.0",
     "npm-run-all": "^4.1.5",
     "prettier": "1.18.2",
     "react": "^16.9.0",

packages/eslint-mdx/package.json

@@ -2,13 +2,13 @@
   "name": "eslint-mdx",
   "version": "1.5.2",
   "description": "ESLint Parser for MDX",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rx-ts/eslint-mdx.git",
-    "directory": "packages/eslint-mdx"
-  },
+  "repository": "git+https://github.com/rx-ts/eslint-mdx.git",
+  "homepage": "https://github.com/rx-ts/eslint-mdx/blob/master/packages/eslint-mdx",
   "author": "JounQin <[email protected]>",
   "license": "MIT",
+  "engines": {
+    "node": ">=7.0.0"
+  },
   "main": "lib",
   "files": [
     "lib",
@@ -26,8 +26,8 @@
   },
   "dependencies": {
     "espree": "^6.1.1",
-    "remark-mdx": "^1.4.4",
+    "remark-mdx": "^1.4.5",
     "remark-parse": "^7.0.1",
-    "unified": "^8.3.2"
+    "unified": "^8.4.0"
   }
 }

packages/eslint-mdx/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
     "composite": true,
     "rootDir": "src",

packages/eslint-plugin-mdx/package.json

@@ -2,13 +2,13 @@
   "name": "eslint-plugin-mdx",
   "version": "1.5.2",
   "description": "ESLint Plugin for MDX",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rx-ts/eslint-mdx.git",
-    "directory": "packages/eslint-plugin-mdx"
-  },
+  "repository": "git+https://github.com/rx-ts/eslint-mdx.git",
+  "homepage": "https://github.com/rx-ts/eslint-mdx/blob/master/packages/eslint-plugin-mdx",
   "author": "JounQin <[email protected]>",
   "license": "MIT",
+  "engines": {
+    "node": ">=7.0.0"
+  },
   "main": "lib",
   "files": [
     "lib",
@@ -22,17 +22,19 @@
     "eslint-mdx"
   ],
   "peerDependencies": {
-    "eslint": ">=5.0.0",
-    "eslint-plugin-react": ">=7.0.0"
+    "eslint": ">=5.0.0"
   },
   "dependencies": {
     "cosmiconfig": "^5.2.1",
     "eslint-mdx": "^1.5.2",
-    "rebass": "^4.0.5",
-    "remark-mdx": "^1.4.4",
+    "eslint-plugin-react": ">=7.0.0",
+    "remark-mdx": "^1.4.5",
     "remark-parse": "^7.0.1",
     "remark-stringify": "^7.0.3",
-    "unified": "^8.3.2",
+    "unified": "^8.4.0",
     "vfile": "^4.0.1"
+  },
+  "optionalDependencies": {
+    "rebass": "^4.0.6"
   }
 }

packages/eslint-plugin-mdx/src/configs/overrides.ts

@@ -1,8 +1,17 @@
-import * as rebass from 'rebass'
-
 import { base } from './base'
 import { getGlobals } from './helper'
 
+let rebass: typeof import('rebass') | string[]
+
+try {
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  rebass = require('rebass')
+} catch {
+  // `rebass`(or `reflexbox` actually) requires `react` as peerDependency, but not all projects using `mdx` are `React` based, so we fallback to hardcoded `rebass` Components here
+  /* istanbul ignore next */
+  rebass = ['Box', 'Flex', 'Text', 'Heading', 'Link', 'Button', 'Image', 'Card']
+}
+
 export const overrides = {
   ...base,
   globals: getGlobals(rebass, {

packages/eslint-plugin-mdx/src/configs/recommended.ts

@@ -19,10 +19,11 @@ export const recommended = {
   },
 }
 
+const OVERRIDES_AVAILABLE_VERSION = 6.4
+
 // overrides in npm pkg is supported after v6.4.0
 // istanbul ignore else
-// eslint-disable-next-line @typescript-eslint/no-magic-numbers
-if (minorVersion >= 6.4) {
+if (minorVersion >= OVERRIDES_AVAILABLE_VERSION) {
   const overrides: Array<{
     files: string | string[]
     extends?: string | string[]

packages/eslint-plugin-mdx/tsconfig.json

@@ -1,6 +1,7 @@
 {
-  "extends": "../../tsconfig.base.json",
+  "extends": "../../tsconfig.base",
   "compilerOptions": {
+    "baseUrl": ".",
     "composite": true,
     "rootDir": "src",
     "outDir": "lib"

packages/eslint-plugin-mdx/typings.d.ts

@@ -9,3 +9,9 @@ declare module 'eslint-plugin-react/lib/rules/no-unescaped-entities' {
   const reactNoUnescapedEntities: Rule.RuleModule
   export = reactNoUnescapedEntities
 }
+
+declare module 'remark-mdx' {
+  import * as unified from 'unified'
+  const mdx: unified.Attacher
+  export = mdx
+}