fix: add repository metadata to all packages (#3613)

* fix: add repository metadata to all packages * empty commit for cla bot * move validate-package-json.test.ts + add glob devDependency Co-authored-by: slorber <lorber.sebastien@gmail.com>
facebook · Oct 21, 2020 · 6930e91 · 6930e91
1 parent 80360b4
commit 6930e91
Show file tree

Hide file tree

Showing 31 changed files with 169 additions and 3 deletions.
diff --git a/__tests__/validate-package-json.test.ts b/__tests__/validate-package-json.test.ts
@@ -0,0 +1,32 @@
+/**
+ * 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 util from 'util';
+import globCb from 'glob';
+import fsCb from 'fs';
+
+const glob = util.promisify(globCb);
+const readFile = util.promisify(fsCb.readFile);
+
+describe('packages', () => {
+  test('should contain repository and directory for every package', async () => {
+    const allPackageJson = await glob('packages/*/package.json');
+    expect(allPackageJson.length).toBeGreaterThan(0);
+
+    /* eslint-disable no-await-in-loop,no-restricted-syntax */
+    for (const packageJson of allPackageJson) {
+      const content = JSON.parse(await readFile(packageJson, 'utf8'));
+      if (content.private !== true) {
+        expect(content.repository).toEqual({
+          type: 'git',
+          url: 'https://github.com/facebook/docusaurus.git',
+          directory: packageJson.replace(/\/package\.json$/, ''),
+        });
+      }
+    }
+  });
+});
diff --git a/package.json b/package.json
@@ -100,6 +100,7 @@
     "eslint-plugin-jsx-a11y": "^6.2.3",
     "eslint-plugin-react": "^7.20.0",
     "eslint-plugin-react-hooks": "^4.0.4",
+    "glob": "^7.1.6",
     "husky": "^4.2.3",
     "jest": "^25.2.7",
     "lerna": "^3.19.0",

diff --git a/packages/docusaurus-1.x/package.json b/packages/docusaurus-1.x/package.json
@@ -11,7 +11,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/facebook/docusaurus.git"
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-1.x"
   },
   "scripts": {
     "start": "cd ../../website-1.x && yarn start"

diff --git a/packages/docusaurus-init-1.x/package.json b/packages/docusaurus-init-1.x/package.json
@@ -10,6 +10,11 @@
     "open source",
     "docusaurus"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-init-1.x"
+  },
   "bin": {
     "docusaurus-init": "initialize.js"
   },

diff --git a/packages/docusaurus-init/package.json b/packages/docusaurus-init/package.json
@@ -4,7 +4,8 @@
   "description": "Create Docusaurus app easily",
   "repository": {
     "type": "git",
-    "url": "https://github.com/facebook/docusaurus.git"
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-init"
   },
   "bugs": {
     "url": "https://github.com/facebook/docusaurus/issues"

diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json
@@ -9,6 +9,11 @@
   "scripts": {
     "build": "tsc"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-mdx-loader"
+  },
   "license": "MIT",
   "dependencies": {
     "@babel/parser": "^7.9.4",

diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json
@@ -11,6 +11,11 @@
     "build": "tsc",
     "watch": "tsc --watch"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-migrate"
+  },
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-module-type-aliases"
+  },
   "devDependencies": {
     "@types/react": "*",
     "@types/react-helmet": "*",

diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json
@@ -7,6 +7,11 @@
     "build": "tsc",
     "watch": "tsc --watch"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-client-redirects"
+  },
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json
@@ -8,6 +8,11 @@
     "build": "tsc",
     "watch": "tsc --watch"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-content-blog"
+  },
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
@@ -11,6 +11,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-content-docs"
+  },
   "license": "MIT",
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json
@@ -11,6 +11,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-content-pages"
+  },
   "license": "MIT",
   "devDependencies": {
     "@types/hapi__joi": "^17.1.2"

diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json
@@ -10,6 +10,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-debug"
+  },
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-google-analytics"
+  },
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66"

diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-google-gtag"
+  },
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66"

diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json
@@ -10,6 +10,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-ideal-image"
+  },
   "license": "MIT",
   "devDependencies": {
     "fs-extra": "^9.0.0"

diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-pwa"
+  },
   "license": "MIT",
   "dependencies": {
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.1",

diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json
@@ -10,6 +10,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-plugin-sitemap"
+  },
   "license": "MIT",
   "devDependencies": {
     "@types/hapi__joi": "^17.1.2"

diff --git a/packages/docusaurus-preset-bootstrap/package.json b/packages/docusaurus-preset-bootstrap/package.json
@@ -7,6 +7,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-preset-bootstrap"
+  },
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",
     "@docusaurus/plugin-content-blog": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-preset-classic"
+  },
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-remark-plugin-npm2yarn"
+  },
   "license": "MIT",
   "dependencies": {
     "npm-to-yarn": "^1.0.1"

diff --git a/packages/docusaurus-theme-bootstrap/package.json b/packages/docusaurus-theme-bootstrap/package.json
@@ -8,6 +8,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-theme-bootstrap"
+  },
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",
     "@docusaurus/plugin-content-blog": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json
@@ -7,6 +7,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-theme-classic"
+  },
   "license": "MIT",
   "scripts": {
     "build": "tsc --noEmit && yarn babel && yarn prettier",

diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-theme-live-codeblock"
+  },
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-alpha.66",

diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-theme-search-algolia"
+  },
   "license": "MIT",
   "dependencies": {
     "@docsearch/react": "^1.0.0-alpha.27",

diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json
@@ -7,6 +7,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-types"
+  },
   "license": "MIT",
   "dependencies": {
     "@types/webpack": "^4.41.0",

diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json
@@ -11,6 +11,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-utils-validation"
+  },
   "license": "MIT",
   "devDependencies": {
     "@types/hapi__joi": "^17.1.2"

diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json
@@ -11,6 +11,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-utils"
+  },
   "license": "MIT",
   "dependencies": {
     "escape-string-regexp": "^2.0.0",

diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json
@@ -17,7 +17,8 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/facebook/docusaurus.git"
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus"
   },
   "bin": {
     "docusaurus": "bin/docusaurus.js"

diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json
@@ -6,6 +6,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/lqip-loader"
+  },
   "license": "MIT",
   "dependencies": {
     "loader-utils": "^1.2.3",

diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json
@@ -4,6 +4,11 @@
   "description": "stylelint plugin to check css files for a copyright header",
   "main": "index.js",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/stylelint-copyright"
+  },
   "dependencies": {
     "stylelint": "^13.2.1"
   }