feat(utils-build): new utility to build plugins

packages/docusaurus-plugin-client-redirects/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-client-redirects.d.ts",
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "repository": {
  "type": "git",
@@ -29,7 +29,8 @@
  "tslib": "^2.3.1"
  },
  "devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15"
  },
  "peerDependencies": {
  "react": "^16.8.4 || ^17.0.0",

packages/docusaurus-plugin-content-blog/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-content-blog.d.ts",
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "repository": {
  "type": "git",
@@ -36,6 +36,7 @@
  },
  "devDependencies": {
  "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15",
  "escape-string-regexp": "^4.0.0"
  },
  "peerDependencies": {

packages/docusaurus-plugin-content-docs/package.json

@@ -10,8 +10,8 @@
  },
  "types": "src/plugin-content-docs.d.ts",
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "publishConfig": {
  "access": "public"
@@ -41,6 +41,7 @@
  "devDependencies": {
  "@docusaurus/module-type-aliases": "2.0.0-beta.15",
  "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15",
  "@types/js-yaml": "^4.0.5",
  "@types/picomatch": "^2.3.0",
  "commander": "^5.1.0",

packages/docusaurus-plugin-content-pages/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-content-pages.d.ts",
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "publishConfig": {
  "access": "public"
@@ -28,7 +28,8 @@
  "webpack": "^5.69.1"
  },
  "devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15"
  },
  "peerDependencies": {
  "react": "^16.8.4 || ^17.0.0",

packages/docusaurus-plugin-debug/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-debug.d.ts",
  "scripts": {
- "build": "tsc && node copyUntypedFiles.mjs",
- "watch": "node copyUntypedFiles.mjs && tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "publishConfig": {
  "access": "public"
@@ -25,7 +25,8 @@
  "tslib": "^2.3.1"
  },
  "devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15"
  },
  "peerDependencies": {
  "react": "^16.8.4 || ^17.0.0",

packages/docusaurus-plugin-google-analytics/package.json

@@ -8,8 +8,8 @@
  "access": "public"
  },
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "repository": {
  "type": "git",
@@ -23,7 +23,8 @@
  "tslib": "^2.3.1"
  },
  "devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15"
  },
  "peerDependencies": {
  "react": "^16.8.4 || ^17.0.0",

packages/docusaurus-plugin-google-gtag/package.json

@@ -5,8 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-google-gtag.d.ts",
  "scripts": {
- "build": "tsc",
- "watch": "tsc --watch"
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "publishConfig": {
  "access": "public"
@@ -23,7 +23,8 @@
  "tslib": "^2.3.1"
  },
  "devDependencies": {
- "@docusaurus/types": "2.0.0-beta.15"
+ "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15"
  },
  "peerDependencies": {
  "react": "^16.8.4 || ^17.0.0",

packages/docusaurus-plugin-ideal-image/package.json

@@ -5,11 +5,8 @@
  "main": "lib/index.js",
  "types": "src/plugin-ideal-image.d.ts",
  "scripts": {
- "build": "yarn build:server && yarn build:browser && yarn build:copy && yarn build:format",
- "build:server": "tsc --project tsconfig.server.json",
- "build:browser": "tsc --project tsconfig.browser.json",
- "build:copy": "node copyUntypedFiles.mjs",
- "build:format": "prettier --config ../../.prettierrc --write \"lib/**/*.js\""
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "publishConfig": {
  "access": "public"
@@ -35,6 +32,7 @@
  "devDependencies": {
  "@docusaurus/module-type-aliases": "2.0.0-beta.15",
  "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15",
  "fs-extra": "^10.0.0"
  },
  "peerDependencies": {

packages/docusaurus-theme-classic/package.json

@@ -14,11 +14,8 @@
  },
  "license": "MIT",
  "scripts": {
- "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn format:lib-next",
- "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\"",
- "babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
- "babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
- "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
+ "build": "docusaurus-plugin build",
+ "watch": "docusaurus-plugin watch"
  },
  "dependencies": {
  "@docusaurus/core": "2.0.0-beta.15",

packages/docusaurus-theme-classic/src/index.ts

@@ -113,7 +113,7 @@ export default function docusaurusThemeClassic(
  name: 'docusaurus-theme-classic',
 
  getThemePath() {
- return path.join(__dirname, '../lib-next/theme');
+ return path.join(__dirname, '../lib/theme');
  },
 
  getTypeScriptThemePath() {

packages/docusaurus-theme-classic/tsconfig.json

@@ -3,9 +3,10 @@
  "compilerOptions": {
  "lib": ["DOM", "ES2019"],
  "module": "esnext",
- "noEmit": true,
  "jsx": "react",
- "baseUrl": "src"
+ "baseUrl": "src",
+ "rootDir": "src",
+ "outDir": "lib"
  },
  "include": ["src/"]
 }

packages/docusaurus-theme-common/package.json

@@ -31,6 +31,7 @@
  "@docusaurus/core": "2.0.0-beta.15",
  "@docusaurus/module-type-aliases": "2.0.0-beta.15",
  "@docusaurus/types": "2.0.0-beta.15",
+ "@docusaurus/utils-build": "2.0.0-beta.15",
  "@testing-library/react-hooks": "^7.0.2",
  "fs-extra": "^10.0.0",
  "lodash": "^4.17.21"

packages/docusaurus-utils-build/README.md

@@ -0,0 +1,9 @@
+# docusaurus-plugin-utils
+
+A utility to build and pack docusaurus plugins, particularly useful for TypeScript plugin authors
+
+## CLI
+
+### `docusaurus-plugin build`
+
+Builds your plugin and transpiles theme components to human-readable JS for swizzling.

packages/docusaurus-utils-build/bin/index.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import logger from '@docusaurus/logger';
+import cli from 'commander';
+import build from '../lib/build.js';
+import watch from '../lib/watch.js';
+
+cli
+ .command('build')
+ .option('--source-dir <dir>')
+ .option('--target-dir <dir>')
+ .option('--theme-dir <dir>')
+ .option('--theme-target-dir <dir>')
+ .option('--ignore <pattern>')
+ .action(build);
+
+cli
+ .command('watch')
+ .option('--source-dir <dir>')
+ .option('--target-dir <dir>')
+ .option('--ignore <pattern>')
+ .action(watch);
+
+cli.arguments('<command>').action((cmd) => {
+ cli.outputHelp();
+ logger.error` Unknown command name=${cmd}.`;
+});
+
+cli.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+ cli.outputHelp();
+}

packages/docusaurus-utils-build/package.json

@@ -0,0 +1,37 @@
+{
+ "name": "@docusaurus/utils-build",
+ "version": "2.0.0-beta.15",
+ "description": "Build and pack docusaurus plugins in one command",
+ "license": "MIT",
+ "type": "module",
+ "publishConfig": {
+ "access": "public"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/facebook/docusaurus.git",
+ "directory": "packages/docusaurus-utils-build"
+ },
+ "bin": {
+ "docusaurus-plugin": "bin/index.js"
+ },
+ "scripts": {
+ "build": "tsc"
+ },
+ "dependencies": {
+ "@babel/core": "^7.17.5",
+ "@babel/plugin-transform-modules-commonjs": "^7.16.8",
+ "@babel/preset-typescript": "^7.16.7",
+ "@docusaurus/logger": "2.0.0-beta.15",
+ "@docusaurus/utils": "2.0.0-beta.15",
+ "chokidar": "^3.5.2",
+ "commander": "^5.1.0",
+ "lodash": "^4.17.21",
+ "prettier": "^2.5.1",
+ "shelljs": "^0.8.5",
+ "typescript": "^4.5.5"
+ },
+ "devDependencies": {
+ "@docusaurus/types": "2.0.0-beta.15"
+ }
+}