mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-10 15:47:23 +02:00
misc: ignore some files during npm publish (#6092)
This commit is contained in:
parent
6ab4efe3a6
commit
77c93cbda6
44 changed files with 150 additions and 53 deletions
7
packages/create-docusaurus/.npmignore
Normal file
7
packages/create-docusaurus/.npmignore
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
__tests__
|
||||||
|
|
||||||
|
# Files in the templates need to stay
|
||||||
|
/tsconfig*
|
||||||
|
/src
|
1
packages/docusaurus-cssnano-preset/.npmignore
Normal file
1
packages/docusaurus-cssnano-preset/.npmignore
Normal file
|
@ -0,0 +1 @@
|
||||||
|
__tests__
|
4
packages/docusaurus-mdx-loader/.npmignore
Normal file
4
packages/docusaurus-mdx-loader/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
6
packages/docusaurus-migrate/.npmignore
Normal file
6
packages/docusaurus-migrate/.npmignore
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
||||||
|
src
|
4
packages/docusaurus-plugin-client-redirects/.npmignore
Normal file
4
packages/docusaurus-plugin-client-redirects/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-content-blog/.npmignore
Normal file
4
packages/docusaurus-plugin-content-blog/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-content-docs/.npmignore
Normal file
4
packages/docusaurus-plugin-content-docs/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-content-pages/.npmignore
Normal file
4
packages/docusaurus-plugin-content-pages/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-debug/.npmignore
Normal file
4
packages/docusaurus-plugin-debug/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-google-analytics/.npmignore
Normal file
4
packages/docusaurus-plugin-google-analytics/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-google-gtag/.npmignore
Normal file
4
packages/docusaurus-plugin-google-gtag/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -1 +1,4 @@
|
||||||
copyUntypedFiles.js
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
4
packages/docusaurus-plugin-pwa/.npmignore
Normal file
4
packages/docusaurus-plugin-pwa/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-plugin-sitemap/.npmignore
Normal file
4
packages/docusaurus-plugin-sitemap/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -6,7 +6,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import {SitemapStream, streamToPromise} from 'sitemap';
|
import {SitemapStream, streamToPromise} from 'sitemap';
|
||||||
import {PluginOptions} from './types';
|
import type {Options} from '@docusaurus/plugin-sitemap';
|
||||||
import {DocusaurusConfig} from '@docusaurus/types';
|
import {DocusaurusConfig} from '@docusaurus/types';
|
||||||
import {addTrailingSlash} from '@docusaurus/utils';
|
import {addTrailingSlash} from '@docusaurus/utils';
|
||||||
import {applyTrailingSlash} from '@docusaurus/utils-common';
|
import {applyTrailingSlash} from '@docusaurus/utils-common';
|
||||||
|
@ -14,7 +14,7 @@ import {applyTrailingSlash} from '@docusaurus/utils-common';
|
||||||
export default async function createSitemap(
|
export default async function createSitemap(
|
||||||
siteConfig: DocusaurusConfig,
|
siteConfig: DocusaurusConfig,
|
||||||
routesPaths: string[],
|
routesPaths: string[],
|
||||||
options: PluginOptions,
|
options: Options,
|
||||||
): Promise<string> {
|
): Promise<string> {
|
||||||
const {url: hostname} = siteConfig;
|
const {url: hostname} = siteConfig;
|
||||||
if (!hostname) {
|
if (!hostname) {
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
|
|
||||||
import fs from 'fs-extra';
|
import fs from 'fs-extra';
|
||||||
import path from 'path';
|
import path from 'path';
|
||||||
import {PluginOptions} from './types';
|
import type {Options} from '@docusaurus/plugin-sitemap';
|
||||||
import createSitemap from './createSitemap';
|
import createSitemap from './createSitemap';
|
||||||
import {
|
import {
|
||||||
LoadContext,
|
LoadContext,
|
||||||
|
@ -20,7 +20,7 @@ import {PluginOptionSchema} from './pluginOptionSchema';
|
||||||
|
|
||||||
export default function pluginSitemap(
|
export default function pluginSitemap(
|
||||||
_context: LoadContext,
|
_context: LoadContext,
|
||||||
options: PluginOptions,
|
options: Options,
|
||||||
): Plugin<void> {
|
): Plugin<void> {
|
||||||
return {
|
return {
|
||||||
name: 'docusaurus-plugin-sitemap',
|
name: 'docusaurus-plugin-sitemap',
|
||||||
|
@ -47,7 +47,7 @@ export default function pluginSitemap(
|
||||||
export function validateOptions({
|
export function validateOptions({
|
||||||
validate,
|
validate,
|
||||||
options,
|
options,
|
||||||
}: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions> {
|
}: OptionValidationContext<Options>): ValidationResult<Options> {
|
||||||
const validatedOptions = validate(PluginOptionSchema, options);
|
const validatedOptions = validate(PluginOptionSchema, options);
|
||||||
return validatedOptions;
|
return validatedOptions;
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,4 +5,10 @@
|
||||||
* LICENSE file in the root directory of this source tree.
|
* 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;
|
||||||
|
};
|
||||||
|
|
|
@ -7,9 +7,9 @@
|
||||||
|
|
||||||
import {Joi} from '@docusaurus/utils-validation';
|
import {Joi} from '@docusaurus/utils-validation';
|
||||||
import {EnumChangefreq} from 'sitemap';
|
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,
|
changefreq: EnumChangefreq.WEEKLY,
|
||||||
priority: 0.5,
|
priority: 0.5,
|
||||||
trailingSlash: false,
|
trailingSlash: false,
|
||||||
|
|
|
@ -1,14 +0,0 @@
|
||||||
/**
|
|
||||||
* 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 {EnumChangefreq} from 'sitemap';
|
|
||||||
|
|
||||||
export type PluginOptions = {
|
|
||||||
changefreq?: EnumChangefreq;
|
|
||||||
priority?: number;
|
|
||||||
trailingSlash?: boolean;
|
|
||||||
};
|
|
4
packages/docusaurus-preset-classic/.npmignore
Normal file
4
packages/docusaurus-preset-classic/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-remark-plugin-npm2yarn/.npmignore
Normal file
4
packages/docusaurus-remark-plugin-npm2yarn/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
10
packages/docusaurus-theme-classic/.npmignore
Normal file
10
packages/docusaurus-theme-classic/.npmignore
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
||||||
|
lib/theme
|
||||||
|
lib-next/**
|
||||||
|
!lib-next/theme/**
|
||||||
|
|
||||||
|
babel.config.js
|
|
@ -13,6 +13,7 @@ import {createRequire} from 'module';
|
||||||
import type {Plugin as PostCssPlugin} from 'postcss';
|
import type {Plugin as PostCssPlugin} from 'postcss';
|
||||||
import rtlcss from 'rtlcss';
|
import rtlcss from 'rtlcss';
|
||||||
import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
|
import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
|
||||||
|
import type {Options} from '@docusaurus/theme-classic';
|
||||||
|
|
||||||
const requireFromDocusaurusCore = createRequire(
|
const requireFromDocusaurusCore = createRequire(
|
||||||
require.resolve('@docusaurus/core/package.json'),
|
require.resolve('@docusaurus/core/package.json'),
|
||||||
|
@ -89,13 +90,9 @@ function getInfimaCSSFile(direction: string) {
|
||||||
}.css`;
|
}.css`;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type PluginOptions = {
|
|
||||||
customCss?: string | string[];
|
|
||||||
};
|
|
||||||
|
|
||||||
export default function docusaurusThemeClassic(
|
export default function docusaurusThemeClassic(
|
||||||
context: DocusaurusContext, // TODO: LoadContext is missing some of properties
|
context: DocusaurusContext, // TODO: LoadContext is missing some of properties
|
||||||
options: PluginOptions,
|
options: Options,
|
||||||
): Plugin<void> {
|
): Plugin<void> {
|
||||||
const {
|
const {
|
||||||
siteConfig: {themeConfig: roughlyTypedThemeConfig},
|
siteConfig: {themeConfig: roughlyTypedThemeConfig},
|
||||||
|
|
|
@ -6,7 +6,9 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
declare module '@docusaurus/theme-classic' {
|
declare module '@docusaurus/theme-classic' {
|
||||||
export type Options = Partial<import('./index').PluginOptions>;
|
export type Options = {
|
||||||
|
customCss?: string | string[];
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
declare module '@theme/AnnouncementBar' {
|
declare module '@theme/AnnouncementBar' {
|
||||||
|
|
4
packages/docusaurus-theme-common/.npmignore
Normal file
4
packages/docusaurus-theme-common/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -4,6 +4,8 @@
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
"module": "esnext",
|
"module": "esnext",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
4
packages/docusaurus-theme-live-codeblock/.npmignore
Normal file
4
packages/docusaurus-theme-live-codeblock/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
4
packages/docusaurus-theme-search-algolia/.npmignore
Normal file
4
packages/docusaurus-theme-search-algolia/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
6
packages/docusaurus-theme-translations/.npmignore
Normal file
6
packages/docusaurus-theme-translations/.npmignore
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
||||||
|
update*
|
|
@ -4,10 +4,6 @@
|
||||||
"description": "Docusaurus theme translations.",
|
"description": "Docusaurus theme translations.",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
"types": "lib/index.d.ts",
|
"types": "lib/index.d.ts",
|
||||||
"files": [
|
|
||||||
"locales",
|
|
||||||
"lib"
|
|
||||||
],
|
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
},
|
},
|
||||||
|
|
|
@ -9,11 +9,7 @@ import path from 'path';
|
||||||
import fs from 'fs-extra';
|
import fs from 'fs-extra';
|
||||||
|
|
||||||
function getDefaultLocalesDirPath(): string {
|
function getDefaultLocalesDirPath(): string {
|
||||||
const parentDirPath = path.join(__dirname, '..');
|
return path.join(__dirname, '../locales');
|
||||||
const pkg = JSON.parse(
|
|
||||||
fs.readFileSync(path.join(parentDirPath, 'package.json'), 'utf8'),
|
|
||||||
);
|
|
||||||
return path.join(parentDirPath, pkg.files[0]);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Return an ordered list of locales we should try
|
// Return an ordered list of locales we should try
|
||||||
|
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
|
@ -9,14 +9,13 @@ const {extractThemeCodeMessages} = require('./update');
|
||||||
const path = require('path');
|
const path = require('path');
|
||||||
const fs = require('fs-extra');
|
const fs = require('fs-extra');
|
||||||
const {mapValues, pickBy} = require('lodash');
|
const {mapValues, pickBy} = require('lodash');
|
||||||
const pkg = require('./package.json');
|
|
||||||
|
|
||||||
// Seems the 5s default timeout fails sometimes
|
// Seems the 5s default timeout fails sometimes
|
||||||
jest.setTimeout(15000);
|
jest.setTimeout(15000);
|
||||||
|
|
||||||
describe('theme-translations package', () => {
|
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 () => {
|
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(
|
const baseMessages = pickBy(
|
||||||
await fs
|
await fs
|
||||||
.readdirSync(baseMessagesDirPath)
|
.readdirSync(baseMessagesDirPath)
|
||||||
|
|
|
@ -1,7 +0,0 @@
|
||||||
{
|
|
||||||
"$schema": "http://json.schemastore.org/tsconfig",
|
|
||||||
"extends": "../../tsconfig.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"noEmit": true
|
|
||||||
}
|
|
||||||
}
|
|
4
packages/docusaurus-utils-common/.npmignore
Normal file
4
packages/docusaurus-utils-common/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib",
|
"outDir": "lib",
|
||||||
"noEmitHelpers": false
|
"noEmitHelpers": false
|
||||||
|
|
4
packages/docusaurus-utils-validation/.npmignore
Normal file
4
packages/docusaurus-utils-validation/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
4
packages/docusaurus-utils/.npmignore
Normal file
4
packages/docusaurus-utils/.npmignore
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
|
@ -3,6 +3,8 @@
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
"tsBuildInfoFile": "./lib/.tsbuildinfo",
|
||||||
|
"sourceMap": true,
|
||||||
|
"declarationMap": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
"outDir": "lib"
|
"outDir": "lib"
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,9 +1,6 @@
|
||||||
src
|
|
||||||
copyUntypedFiles.js
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
||||||
# production
|
src
|
||||||
/build
|
|
||||||
|
|
||||||
# generated files
|
|
||||||
.docusaurus
|
|
||||||
.cache-loader
|
|
||||||
|
|
6
packages/lqip-loader/.npmignore
Normal file
6
packages/lqip-loader/.npmignore
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
copyUntypedFiles.js
|
||||||
|
.tsbuildinfo
|
||||||
|
tsconfig*
|
||||||
|
__tests__
|
||||||
|
|
||||||
|
src
|
Loading…
Add table
Add a link
Reference in a new issue