@modern-js/plugin-docsite 1.2.4 → 1.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.eslintrc.js ADDED
@@ -0,0 +1,8 @@
1
+ module.exports = {
2
+ root: true,
3
+ extends: ['@modern-js'],
4
+ parserOptions: {
5
+ tsconfigRootDir: __dirname,
6
+ project: ['./tsconfig.json'],
7
+ },
8
+ };
package/CHANGELOG.md CHANGED
@@ -1,5 +1,54 @@
1
1
  # @modern-js/plugin-docsite
2
2
 
3
+ ## 1.2.7
4
+
5
+ ### Patch Changes
6
+
7
+ - 6cffe99d: chore:
8
+ remove react eslint rules for `modern-js` rule set.
9
+ add .eslintrc for each package to speed up linting
10
+ - 04ae5262: chore: bump @modern-js/utils to v1.4.1 in dependencies
11
+ - 60f7d8bf: feat: add tests dir to npmignore
12
+ - 5dbbeb57: fix: export extended Command type
13
+ - Updated dependencies [b8599d09]
14
+ - Updated dependencies [6cffe99d]
15
+ - Updated dependencies [04ae5262]
16
+ - Updated dependencies [60f7d8bf]
17
+ - Updated dependencies [e4cec1ce]
18
+ - Updated dependencies [3bf4f8b0]
19
+ - @modern-js/utils@1.5.0
20
+ - @modern-js/webpack@1.5.5
21
+
22
+ ## 1.2.6
23
+
24
+ ### Patch Changes
25
+
26
+ - 17d0cc46: feat: prebundle lodash to @modern-js/utils/lodash
27
+ - Updated dependencies [ec1b7367]
28
+ - Updated dependencies [77ff9754]
29
+ - Updated dependencies [d2d1d6b2]
30
+ - Updated dependencies [07a4887e]
31
+ - Updated dependencies [ea2ae711]
32
+ - Updated dependencies [17d0cc46]
33
+ - Updated dependencies [d2d1d6b2]
34
+ - @modern-js/webpack@1.5.4
35
+ - @modern-js/utils@1.4.0
36
+
37
+ ## 1.2.5
38
+
39
+ ### Patch Changes
40
+
41
+ - bebb39b6: chore: improve devDependencies and peerDependencies
42
+ - 133a5dd7: remove module hooks dep
43
+ - Updated dependencies [bebb39b6]
44
+ - Updated dependencies [4b4e73b7]
45
+ - Updated dependencies [da60172c]
46
+ - Updated dependencies [6cff93dc]
47
+ - Updated dependencies [132f7b53]
48
+ - Updated dependencies [9d4a005b]
49
+ - @modern-js/webpack@1.5.3
50
+ - @modern-js/utils@1.3.7
51
+
3
52
  ## 1.2.4
4
53
 
5
54
  ### Patch Changes
@@ -1,7 +1,6 @@
1
1
  import { logger, Import, chalk } from '@modern-js/utils';
2
2
  const wp = Import.lazy('./utils/webpack', require);
3
- const gen = Import.lazy('./utils/generate-files', require); // eslint-disable-next-line max-params
4
-
3
+ const gen = Import.lazy('./utils/generate-files', require);
5
4
  export async function build(appDirectory, tmpDir, files, webpackConfig, isDev) {
6
5
  const meta = await gen.generateFiles(appDirectory, tmpDir, files, isDev);
7
6
 
@@ -3,8 +3,7 @@ import { logger } from '@modern-js/utils';
3
3
  import webpack from 'webpack';
4
4
  import WebpackDevServer from 'webpack-dev-server';
5
5
  import { chokidarFile } from "./utils/chokidar";
6
- import { generateFiles } from "./utils/generate-files"; // eslint-disable-next-line max-params
7
-
6
+ import { generateFiles } from "./utils/generate-files";
8
7
  export async function dev(appDirectory, tmpDir, files, webpackConfig, isDev, port) {
9
8
  await generateFiles(appDirectory, tmpDir, files, isDev);
10
9
  const compiler = webpack(webpackConfig);
@@ -1,10 +1,9 @@
1
1
  import path from 'path';
2
- import { fs, Import, logger } from '@modern-js/utils';
2
+ import { fs, glob, Import, logger } from '@modern-js/utils';
3
3
  import { valid } from "./utils/valid";
4
4
  const buildFeat = Import.lazy('./build', require);
5
5
  const devFeat = Import.lazy('./dev', require);
6
6
  const wp = Import.lazy('./utils/webpack', require);
7
- const glob = Import.lazy('glob', require);
8
7
  const DEFAULT_PORT = 5000;
9
8
  export async function buildDocs({
10
9
  appDirectory,
@@ -1,7 +1,5 @@
1
1
  import path from 'path';
2
- import { logger } from '@modern-js/utils';
3
- import chokidar from 'chokidar';
4
- import glob from 'glob';
2
+ import { glob, logger, chokidar } from '@modern-js/utils';
5
3
  import { generateFiles } from "./generate-files";
6
4
  export function chokidarFile(appDirectory, tmpDir, isDev) {
7
5
  let dirty = false;
@@ -24,8 +22,7 @@ export function chokidarFile(appDirectory, tmpDir, isDev) {
24
22
  if (files.length) {
25
23
  await generateFiles(appDirectory, tmpDir, files, isDev);
26
24
  logger.info('built');
27
- } // eslint-disable-next-line require-atomic-updates
28
-
25
+ }
29
26
 
30
27
  building = false;
31
28
 
@@ -1,9 +1,3 @@
1
- import _difference from "lodash/difference";
2
- import _template from "lodash/template";
3
- import _union from "lodash/union";
4
- import _camelCase from "lodash/camelCase";
5
- import _startCase from "lodash/startCase";
6
-
7
1
  function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
8
2
 
9
3
  function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -13,6 +7,7 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
13
7
  import path from 'path';
14
8
  import { logger, fs } from '@modern-js/utils';
15
9
  import matter from 'gray-matter';
10
+ import { startCase, camelCase, union, template, difference } from '@modern-js/utils/lodash';
16
11
  import GithubSlugger from 'github-slugger';
17
12
  import sortPaths from 'sort-paths';
18
13
  import visit from 'unist-util-visit';
@@ -31,19 +26,18 @@ const loadTemplate = async (file, customPath = false) => {
31
26
  result = await fs.readFile(path.join(UTILS_STATIC, file), 'utf-8');
32
27
  }
33
28
 
34
- return _template(result, {
29
+ return template(result, {
35
30
  interpolate: /<%=([\s\S]+?)%>/g
36
31
  });
37
32
  };
38
33
 
39
- // eslint-disable-next-line max-statements
40
34
  async function handleFile(appDirectory, tmpDir, file, images) {
41
35
  const moduleName = file.replace(/\.(md|mdx)$/, '');
42
36
  const content = await fs.readFile(path.resolve(appDirectory, 'docs', file));
43
37
  const parsed = matter(content);
44
38
 
45
39
  if (!parsed.data.title) {
46
- parsed.data.title = _startCase(_camelCase(path.basename(moduleName)));
40
+ parsed.data.title = startCase(camelCase(path.basename(moduleName)));
47
41
  }
48
42
 
49
43
  const slugger = new GithubSlugger();
@@ -85,12 +79,10 @@ async function handleFile(appDirectory, tmpDir, file, images) {
85
79
  }
86
80
  });
87
81
  });
88
-
89
- const extraImported = _difference(imported.map(n => n.id), exported.map(n => n.id)); // we have to put the export statement with the import,
82
+ const extraImported = difference(imported.map(n => n.id), exported.map(n => n.id)); // we have to put the export statement with the import,
90
83
  // otherwise the mdx's babel transformer cannot found
91
84
  // the corresponding imports
92
85
 
93
-
94
86
  extraImported.forEach(id => {
95
87
  const {
96
88
  node
@@ -141,9 +133,7 @@ async function handleFile(appDirectory, tmpDir, file, images) {
141
133
  const transpiled = await mdx(parsed.content, {
142
134
  remarkPlugins: [modifier]
143
135
  });
144
-
145
- const totalExported = _union(imported.map(n => n.id), exported.map(n => n.id));
146
-
136
+ const totalExported = union(imported.map(n => n.id), exported.map(n => n.id));
147
137
  const outputFile = path.resolve(tmpDir, `${moduleName}/mdx.jsx`);
148
138
  await fs.outputFile(outputFile, MDX_DEFAULT_RENDERER + transpiled, {
149
139
  encoding: 'utf8'
@@ -1,6 +1,5 @@
1
1
  import path from 'path';
2
- import * as glob from 'glob';
3
- import { chalk, fs } from '@modern-js/utils';
2
+ import { chalk, fs, glob } from '@modern-js/utils';
4
3
  export const valid = ({
5
4
  appDirectory,
6
5
  docsDir
@@ -9,8 +9,7 @@ var _utils = require("@modern-js/utils");
9
9
 
10
10
  const wp = _utils.Import.lazy('./utils/webpack', require);
11
11
 
12
- const gen = _utils.Import.lazy('./utils/generate-files', require); // eslint-disable-next-line max-params
13
-
12
+ const gen = _utils.Import.lazy('./utils/generate-files', require);
14
13
 
15
14
  async function build(appDirectory, tmpDir, files, webpackConfig, isDev) {
16
15
  const meta = await gen.generateFiles(appDirectory, tmpDir, files, isDev);
@@ -19,7 +19,6 @@ var _generateFiles = require("./utils/generate-files");
19
19
 
20
20
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
21
21
 
22
- // eslint-disable-next-line max-params
23
22
  async function dev(appDirectory, tmpDir, files, webpackConfig, isDev, port) {
24
23
  await (0, _generateFiles.generateFiles)(appDirectory, tmpDir, files, isDev);
25
24
  const compiler = (0, _webpack.default)(webpackConfig);
@@ -19,8 +19,6 @@ const devFeat = _utils.Import.lazy('./dev', require);
19
19
 
20
20
  const wp = _utils.Import.lazy('./utils/webpack', require);
21
21
 
22
- const glob = _utils.Import.lazy('glob', require);
23
-
24
22
  const DEFAULT_PORT = 5000;
25
23
 
26
24
  async function buildDocs({
@@ -42,7 +40,7 @@ async function buildDocs({
42
40
  return;
43
41
  }
44
42
 
45
- const files = glob.sync('**/*.{md,mdx}', {
43
+ const files = _utils.glob.sync('**/*.{md,mdx}', {
46
44
  cwd: docsDir,
47
45
  ignore: '**/_*'
48
46
  });
@@ -9,10 +9,6 @@ var _path = _interopRequireDefault(require("path"));
9
9
 
10
10
  var _utils = require("@modern-js/utils");
11
11
 
12
- var _chokidar = _interopRequireDefault(require("chokidar"));
13
-
14
- var _glob = _interopRequireDefault(require("glob"));
15
-
16
12
  var _generateFiles = require("./generate-files");
17
13
 
18
14
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -21,7 +17,7 @@ function chokidarFile(appDirectory, tmpDir, isDev) {
21
17
  let dirty = false;
22
18
  let building = false;
23
19
 
24
- _chokidar.default.watch('docs/**/*.{md,mdx}', {
20
+ _utils.chokidar.watch('docs/**/*.{md,mdx}', {
25
21
  cwd: appDirectory,
26
22
  ignoreInitial: true
27
23
  }).on('all', async () => {
@@ -33,7 +29,7 @@ function chokidarFile(appDirectory, tmpDir, isDev) {
33
29
 
34
30
  _utils.logger.info('changed, collect and rebuild docs');
35
31
 
36
- const files = _glob.default.sync('**/*.{md,mdx}', {
32
+ const files = _utils.glob.sync('**/*.{md,mdx}', {
37
33
  cwd: _path.default.resolve(appDirectory, 'docs'),
38
34
  ignore: '**/_*'
39
35
  });
@@ -42,8 +38,7 @@ function chokidarFile(appDirectory, tmpDir, isDev) {
42
38
  await (0, _generateFiles.generateFiles)(appDirectory, tmpDir, files, isDev);
43
39
 
44
40
  _utils.logger.info('built');
45
- } // eslint-disable-next-line require-atomic-updates
46
-
41
+ }
47
42
 
48
43
  building = false;
49
44
 
@@ -5,22 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.generateFiles = generateFiles;
7
7
 
8
- var _difference2 = _interopRequireDefault(require("lodash/difference"));
9
-
10
- var _template2 = _interopRequireDefault(require("lodash/template"));
11
-
12
- var _union2 = _interopRequireDefault(require("lodash/union"));
13
-
14
- var _camelCase2 = _interopRequireDefault(require("lodash/camelCase"));
15
-
16
- var _startCase2 = _interopRequireDefault(require("lodash/startCase"));
17
-
18
8
  var _path = _interopRequireDefault(require("path"));
19
9
 
20
10
  var _utils = require("@modern-js/utils");
21
11
 
22
12
  var _grayMatter = _interopRequireDefault(require("gray-matter"));
23
13
 
14
+ var _lodash = require("@modern-js/utils/lodash");
15
+
24
16
  var _githubSlugger = _interopRequireDefault(require("github-slugger"));
25
17
 
26
18
  var _sortPaths = _interopRequireDefault(require("sort-paths"));
@@ -54,19 +46,18 @@ const loadTemplate = async (file, customPath = false) => {
54
46
  result = await _utils.fs.readFile(_path.default.join(_constant.UTILS_STATIC, file), 'utf-8');
55
47
  }
56
48
 
57
- return (0, _template2.default)(result, {
49
+ return (0, _lodash.template)(result, {
58
50
  interpolate: /<%=([\s\S]+?)%>/g
59
51
  });
60
52
  };
61
53
 
62
- // eslint-disable-next-line max-statements
63
54
  async function handleFile(appDirectory, tmpDir, file, images) {
64
55
  const moduleName = file.replace(/\.(md|mdx)$/, '');
65
56
  const content = await _utils.fs.readFile(_path.default.resolve(appDirectory, 'docs', file));
66
57
  const parsed = (0, _grayMatter.default)(content);
67
58
 
68
59
  if (!parsed.data.title) {
69
- parsed.data.title = (0, _startCase2.default)((0, _camelCase2.default)(_path.default.basename(moduleName)));
60
+ parsed.data.title = (0, _lodash.startCase)((0, _lodash.camelCase)(_path.default.basename(moduleName)));
70
61
  }
71
62
 
72
63
  const slugger = new _githubSlugger.default();
@@ -110,7 +101,7 @@ async function handleFile(appDirectory, tmpDir, file, images) {
110
101
  }
111
102
  });
112
103
  });
113
- const extraImported = (0, _difference2.default)(imported.map(n => n.id), exported.map(n => n.id)); // we have to put the export statement with the import,
104
+ const extraImported = (0, _lodash.difference)(imported.map(n => n.id), exported.map(n => n.id)); // we have to put the export statement with the import,
114
105
  // otherwise the mdx's babel transformer cannot found
115
106
  // the corresponding imports
116
107
 
@@ -165,7 +156,7 @@ async function handleFile(appDirectory, tmpDir, file, images) {
165
156
  const transpiled = await (0, _mdx.default)(parsed.content, {
166
157
  remarkPlugins: [modifier]
167
158
  });
168
- const totalExported = (0, _union2.default)(imported.map(n => n.id), exported.map(n => n.id));
159
+ const totalExported = (0, _lodash.union)(imported.map(n => n.id), exported.map(n => n.id));
169
160
 
170
161
  const outputFile = _path.default.resolve(tmpDir, `${moduleName}/mdx.jsx`);
171
162
 
@@ -7,14 +7,8 @@ exports.valid = void 0;
7
7
 
8
8
  var _path = _interopRequireDefault(require("path"));
9
9
 
10
- var glob = _interopRequireWildcard(require("glob"));
11
-
12
10
  var _utils = require("@modern-js/utils");
13
11
 
14
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
15
-
16
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
17
-
18
12
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
19
13
 
20
14
  const valid = ({
@@ -23,7 +17,7 @@ const valid = ({
23
17
  }) => {
24
18
  const docsAbsPath = _path.default.join(appDirectory, docsDir);
25
19
 
26
- const files = glob.sync(`${docsAbsPath}/**/*.{md,mdx}`);
20
+ const files = _utils.glob.sync(`${docsAbsPath}/**/*.{md,mdx}`);
27
21
 
28
22
  if (!_utils.fs.existsSync(docsAbsPath) || files.length <= 0) {
29
23
  console.info(_utils.chalk.yellow('No docs found, create directory "./docs" and add md(x) files'));
package/jest.config.js CHANGED
@@ -2,7 +2,6 @@ const sharedConfig = require('@scripts/jest-config');
2
2
 
3
3
  /** @type {import('@jest/types').Config.InitialOptions} */
4
4
  module.exports = {
5
- // eslint-disable-next-line node/no-unsupported-features/es-syntax
6
5
  ...sharedConfig,
7
6
  rootDir: __dirname,
8
7
  };
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "modern",
12
12
  "modern.js"
13
13
  ],
14
- "version": "1.2.4",
14
+ "version": "1.2.7",
15
15
  "jsnext:source": "./src/index.ts",
16
16
  "types": "./dist/types/index.d.ts",
17
17
  "main": "./dist/js/node/index.js",
@@ -37,16 +37,13 @@
37
37
  "@babel/runtime": "^7",
38
38
  "@mdx-js/mdx": "^1.6.22",
39
39
  "@mdx-js/react": "^1.6.22",
40
- "@modern-js/utils": "^1.3.6",
41
- "@modern-js/webpack": "^1.5.0",
40
+ "@modern-js/utils": "^1.5.0",
41
+ "@modern-js/webpack": "^1.5.6",
42
42
  "antd": "^4.16.13",
43
- "chokidar": "^3.5.2",
44
43
  "core-js": "^3.17.2",
45
44
  "github-slugger": "^1.4.0",
46
- "glob": "^7.1.6",
47
45
  "gray-matter": "^4.0.3",
48
46
  "html-webpack-plugin": "^5.3.2",
49
- "lodash": "^4.17.21",
50
47
  "mdast-util-to-string": "^2.0.0",
51
48
  "path-browserify": "^1.0.1",
52
49
  "prism-react-renderer": "^1.2.1",
@@ -55,28 +52,25 @@
55
52
  "react-live": "^2.3.0",
56
53
  "react-router-dom": "^5.3.0",
57
54
  "sort-paths": "^1.1.1",
58
- "styled-components": "^5.3.1",
59
55
  "unist-builder": "^2.0.3",
60
56
  "unist-util-visit": "^2.0.3",
61
- "webpack": "^5.54.0",
57
+ "webpack": "^5.71.0",
62
58
  "webpack-dev-server": "^4.1.1"
63
59
  },
64
60
  "devDependencies": {
65
- "@modern-js/module-tools-hooks": "^1.2.3",
61
+ "@modern-js/core": "1.8.0",
62
+ "@scripts/build": "0.0.0",
63
+ "@scripts/jest-config": "0.0.0",
66
64
  "@types/core-js": "^2.5.5",
67
65
  "@types/github-slugger": "^1.3.0",
68
66
  "@types/glob": "^7.1.4",
69
67
  "@types/jest": "^26",
70
- "@types/lodash": "^4.14.168",
71
68
  "@types/node": "^14",
72
69
  "@types/react": "^17",
73
70
  "@types/react-dom": "^17",
74
71
  "@types/webpack-dev-server": "^4.1.0",
75
- "typescript": "^4",
76
- "@modern-js/core": "^1.6.0",
77
- "@scripts/build": "0.0.0",
78
72
  "jest": "^27",
79
- "@scripts/jest-config": "0.0.0"
73
+ "typescript": "^4"
80
74
  },
81
75
  "sideEffects": false,
82
76
  "modernConfig": {
@@ -1,7 +0,0 @@
1
- import plugin from '../src';
2
-
3
- describe('plugin-docset', () => {
4
- it('default', () => {
5
- expect(plugin).toBeDefined();
6
- });
7
- });
@@ -1,13 +0,0 @@
1
- {
2
- "extends": "@modern-js/tsconfig/base",
3
- "compilerOptions": {
4
- "declaration": true,
5
- "jsx": "preserve",
6
- "baseUrl": "./",
7
- "outDir": "./out",
8
- "emitDeclarationOnly": true,
9
- "isolatedModules": true,
10
- "paths": {},
11
- "types": ["node", "jest"]
12
- }
13
- }