misc: ignore some files during npm publish (#6092)

facebook · Dec 17, 2021 · 77c93cb · 77c93cb
1 parent 6ab4efe
commit 77c93cb
Show file tree

Hide file tree

Showing 44 changed files with 150 additions and 53 deletions.
diff --git a/packages/create-docusaurus/.npmignore b/packages/create-docusaurus/.npmignore
@@ -0,0 +1,7 @@
+copyUntypedFiles.js
+.tsbuildinfo
+__tests__
+
+# Files in the templates need to stay
+/tsconfig*
+/src
diff --git a/packages/docusaurus-cssnano-preset/.npmignore b/packages/docusaurus-cssnano-preset/.npmignore
@@ -0,0 +1 @@
+__tests__
diff --git a/packages/docusaurus-mdx-loader/.npmignore b/packages/docusaurus-mdx-loader/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-mdx-loader/tsconfig.json b/packages/docusaurus-mdx-loader/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus-migrate/.npmignore b/packages/docusaurus-migrate/.npmignore
@@ -0,0 +1,6 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
+
+src
diff --git a/packages/docusaurus-plugin-client-redirects/.npmignore b/packages/docusaurus-plugin-client-redirects/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-content-blog/.npmignore b/packages/docusaurus-plugin-content-blog/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-content-docs/.npmignore b/packages/docusaurus-plugin-content-docs/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-content-pages/.npmignore b/packages/docusaurus-plugin-content-pages/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-debug/.npmignore b/packages/docusaurus-plugin-debug/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-google-analytics/.npmignore b/packages/docusaurus-plugin-google-analytics/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-google-gtag/.npmignore b/packages/docusaurus-plugin-google-gtag/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-ideal-image/.npmignore b/packages/docusaurus-plugin-ideal-image/.npmignore
@@ -1 +1,4 @@
 copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-pwa/.npmignore b/packages/docusaurus-plugin-pwa/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-sitemap/.npmignore b/packages/docusaurus-plugin-sitemap/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-plugin-sitemap/src/createSitemap.ts b/packages/docusaurus-plugin-sitemap/src/createSitemap.ts
@@ -6,15 +6,15 @@
  */
 
 import {SitemapStream, streamToPromise} from 'sitemap';
-import {PluginOptions} from './types';
+import type {Options} from '@docusaurus/plugin-sitemap';
 import {DocusaurusConfig} from '@docusaurus/types';
 import {addTrailingSlash} from '@docusaurus/utils';
 import {applyTrailingSlash} from '@docusaurus/utils-common';
 
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
   routesPaths: string[],
-  options: PluginOptions,
+  options: Options,
 ): Promise<string> {
   const {url: hostname} = siteConfig;
   if (!hostname) {

diff --git a/packages/docusaurus-plugin-sitemap/src/index.ts b/packages/docusaurus-plugin-sitemap/src/index.ts
@@ -7,7 +7,7 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import {PluginOptions} from './types';
+import type {Options} from '@docusaurus/plugin-sitemap';
 import createSitemap from './createSitemap';
 import {
   LoadContext,
@@ -20,7 +20,7 @@ import {PluginOptionSchema} from './pluginOptionSchema';
 
 export default function pluginSitemap(
   _context: LoadContext,
-  options: PluginOptions,
+  options: Options,
 ): Plugin<void> {
   return {
     name: 'docusaurus-plugin-sitemap',
@@ -47,7 +47,7 @@ export default function pluginSitemap(
 export function validateOptions({
   validate,
   options,
-}: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions> {
+}: OptionValidationContext<Options>): ValidationResult<Options> {
   const validatedOptions = validate(PluginOptionSchema, options);
   return validatedOptions;
 }
diff --git a/packages/docusaurus-plugin-sitemap/src/plugin-sitemap.d.ts b/packages/docusaurus-plugin-sitemap/src/plugin-sitemap.d.ts
@@ -5,4 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-export type Options = Partial<import('./types').PluginOptions>;
+import {EnumChangefreq} from 'sitemap';
+
+export type Options = {
+  changefreq?: EnumChangefreq;
+  priority?: number;
+  trailingSlash?: boolean;
+};
diff --git a/packages/docusaurus-plugin-sitemap/src/pluginOptionSchema.ts b/packages/docusaurus-plugin-sitemap/src/pluginOptionSchema.ts
@@ -7,9 +7,9 @@
 
 import {Joi} from '@docusaurus/utils-validation';
 import {EnumChangefreq} from 'sitemap';
-import {PluginOptions} from './types';
+import type {Options} from '@docusaurus/plugin-sitemap';
 
-export const DEFAULT_OPTIONS: Required<PluginOptions> = {
+export const DEFAULT_OPTIONS: Required<Options> = {
   changefreq: EnumChangefreq.WEEKLY,
   priority: 0.5,
   trailingSlash: false,

diff --git a/packages/docusaurus-plugin-sitemap/src/types.ts b/packages/docusaurus-plugin-sitemap/src/types.ts
diff --git a/packages/docusaurus-preset-classic/.npmignore b/packages/docusaurus-preset-classic/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/.npmignore b/packages/docusaurus-remark-plugin-npm2yarn/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/tsconfig.json b/packages/docusaurus-remark-plugin-npm2yarn/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus-theme-classic/.npmignore b/packages/docusaurus-theme-classic/.npmignore
@@ -0,0 +1,10 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
+
+lib/theme
+lib-next/**
+!lib-next/theme/**
+
+babel.config.js
diff --git a/packages/docusaurus-theme-classic/src/index.ts b/packages/docusaurus-theme-classic/src/index.ts
@@ -13,6 +13,7 @@ import {createRequire} from 'module';
 import type {Plugin as PostCssPlugin} from 'postcss';
 import rtlcss from 'rtlcss';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
+import type {Options} from '@docusaurus/theme-classic';
 
 const requireFromDocusaurusCore = createRequire(
   require.resolve('@docusaurus/core/package.json'),
@@ -89,13 +90,9 @@ function getInfimaCSSFile(direction: string) {
   }.css`;
 }
 
-export type PluginOptions = {
-  customCss?: string | string[];
-};
-
 export default function docusaurusThemeClassic(
   context: DocusaurusContext, // TODO: LoadContext is missing some of properties
-  options: PluginOptions,
+  options: Options,
 ): Plugin<void> {
   const {
     siteConfig: {themeConfig: roughlyTypedThemeConfig},

diff --git a/packages/docusaurus-theme-classic/src/theme-classic.d.ts b/packages/docusaurus-theme-classic/src/theme-classic.d.ts
@@ -6,7 +6,9 @@
  */
 
 declare module '@docusaurus/theme-classic' {
-  export type Options = Partial<import('./index').PluginOptions>;
+  export type Options = {
+    customCss?: string | string[];
+  };
 }
 
 declare module '@theme/AnnouncementBar' {

diff --git a/packages/docusaurus-theme-common/.npmignore b/packages/docusaurus-theme-common/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-theme-common/tsconfig.json b/packages/docusaurus-theme-common/tsconfig.json
@@ -4,6 +4,8 @@
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
     "module": "esnext",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus-theme-live-codeblock/.npmignore b/packages/docusaurus-theme-live-codeblock/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-theme-search-algolia/.npmignore b/packages/docusaurus-theme-search-algolia/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-theme-translations/.npmignore b/packages/docusaurus-theme-translations/.npmignore
@@ -0,0 +1,6 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
+
+update*
diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json
@@ -4,10 +4,6 @@
   "description": "Docusaurus theme translations.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "files": [
-    "locales",
-    "lib"
-  ],
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/docusaurus-theme-translations/src/index.ts b/packages/docusaurus-theme-translations/src/index.ts
@@ -9,11 +9,7 @@ import path from 'path';
 import fs from 'fs-extra';
 
 function getDefaultLocalesDirPath(): string {
-  const parentDirPath = path.join(__dirname, '..');
-  const pkg = JSON.parse(
-    fs.readFileSync(path.join(parentDirPath, 'package.json'), 'utf8'),
-  );
-  return path.join(parentDirPath, pkg.files[0]);
+  return path.join(__dirname, '../locales');
 }
 
 // Return an ordered list of locales we should try

diff --git a/packages/docusaurus-theme-translations/tsconfig.json b/packages/docusaurus-theme-translations/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus-theme-translations/update.test.js b/packages/docusaurus-theme-translations/update.test.js
@@ -9,14 +9,13 @@ const {extractThemeCodeMessages} = require('./update');
 const path = require('path');
 const fs = require('fs-extra');
 const {mapValues, pickBy} = require('lodash');
-const pkg = require('./package.json');
 
 // Seems the 5s default timeout fails sometimes
 jest.setTimeout(15000);
 
 describe('theme-translations package', () => {
   test(`to have base messages files contain EXACTLY all the translations extracted from the theme. Please run "yarn workspace @docusaurus/theme-translations update" to keep base messages files up-to-date.`, async () => {
-    const baseMessagesDirPath = path.join(__dirname, pkg.files[0], 'base');
+    const baseMessagesDirPath = path.join(__dirname, 'locales/base');
     const baseMessages = pickBy(
       await fs
         .readdirSync(baseMessagesDirPath)

diff --git a/packages/docusaurus-types/tsconfig.json b/packages/docusaurus-types/tsconfig.json
diff --git a/packages/docusaurus-utils-common/.npmignore b/packages/docusaurus-utils-common/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-utils-common/tsconfig.json b/packages/docusaurus-utils-common/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib",
     "noEmitHelpers": false

diff --git a/packages/docusaurus-utils-validation/.npmignore b/packages/docusaurus-utils-validation/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-utils-validation/tsconfig.json b/packages/docusaurus-utils-validation/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus-utils/.npmignore b/packages/docusaurus-utils/.npmignore
@@ -0,0 +1,4 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
diff --git a/packages/docusaurus-utils/tsconfig.json b/packages/docusaurus-utils/tsconfig.json
@@ -3,6 +3,8 @@
   "compilerOptions": {
     "incremental": true,
     "tsBuildInfoFile": "./lib/.tsbuildinfo",
+    "sourceMap": true,
+    "declarationMap": true,
     "rootDir": "src",
     "outDir": "lib"
   }

diff --git a/packages/docusaurus/.npmignore b/packages/docusaurus/.npmignore
@@ -1,9 +1,6 @@
-src
 copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
 
-# production
-/build
-
-# generated files
-.docusaurus
-.cache-loader
+src
diff --git a/packages/lqip-loader/.npmignore b/packages/lqip-loader/.npmignore
@@ -0,0 +1,6 @@
+copyUntypedFiles.js
+.tsbuildinfo
+tsconfig*
+__tests__
+
+src