3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-09 23:27:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(v2): ensure publishConfig.access presence with tests (#3786)

Browse source
This commit is contained in:
Sébastien Lorber 2020-11-19 17:14:45 +01:00 • committed by GitHub
parent a4e0992b27
commit 04f307cf66
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

64
__tests__/validate-package-json.test.ts
View file

@ -12,21 +12,63 @@ 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);
type PackageJsonFile = {
file: string;
content: any;
};
/* 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({
async function getPackagesJsonFiles(): Promise<PackageJsonFile[]> {
const files = await glob('packages/*/package.json');
return Promise.all(
files.map(async (file) => {
return {
file,
content: JSON.parse(await readFile(file, 'utf8')),
};
}),
);
}
describe('packages', () => {
test('should be found', async () => {
const packageJsonFiles = await getPackagesJsonFiles();
expect(packageJsonFiles.length).toBeGreaterThan(0);
});
test('should contain repository and directory for every package', async () => {
const packageJsonFiles = await getPackagesJsonFiles();
packageJsonFiles.forEach((packageJsonFile) => {
if (packageJsonFile.content.private !== true) {
expect(packageJsonFile.content.repository).toEqual({
type: 'git',
url: 'https://github.com/facebook/docusaurus.git',
directory: packageJson.replace(/\/package\.json$/, ''),
directory: packageJsonFile.file.replace(/\/package\.json$/, ''),
});
}
}
});
});
/*
If a package starts with @, if won't be published to public npm registry
without an additional publishConfig.acces: "public" config
This will make you publish an incomplete list of Docusaurus packages
when trying to release with lerna-publish
*/
test('should have publishConfig.access: "public" when name starts with @', async () => {
const packageJsonFiles = await getPackagesJsonFiles();
packageJsonFiles.forEach((packageJsonFile) => {
if (packageJsonFile.content.name.startsWith('@')) {
// Unfortunately jest custom message do not exist in loops, so using an exception instead to show failing package file
// (see https://github.com/facebook/jest/issues/3293)
// expect(packageJsonFile.content.publishConfig?.access).toEqual('public');
if (packageJsonFile.content.publishConfig?.access !== 'public') {
throw new Error(
`Package ${packageJsonFile.file} does not have publishConfig.access: 'public'`,
);
}
}
});
});
});