Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-03-17 23:11:29 -05:00
Code Issues Activity

fix(create-astro): respect existing package.json#scripts (#8911)

Browse source
This commit is contained in:
Nate Moore 2023-10-24 13:48:17 -05:00 • committed by GitHub
parent a86b41c852
commit b236d88add
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 31 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/tame-wasps-exercise.md Normal file
View file

@ -0,0 +1,5 @@
---
'create-astro': patch
---
Ensure an existing template's `package.json` `scripts` are respected when modifying `build`.

10
packages/create-astro/src/actions/typescript.ts
View file

@ -96,13 +96,9 @@ const FILES_TO_UPDATE = {
// in case of any other template already have astro checks defined, we don't want to override it
if (typeof buildScript === 'string' && !buildScript.includes('astro check')) {
const newPackageJson = Object.assign(parsedPackageJson, {
scripts: {
build: 'astro check && ' + buildScript,
},
});
await writeFile(file, JSON.stringify(newPackageJson, null, indent), 'utf-8');
// Mutate the existing object to avoid changing user-defined script order
parsedPackageJson.scripts.build = `astro check && ${buildScript}`;
await writeFile(file, JSON.stringify(parsedPackageJson, null, indent), 'utf-8');
}
} catch (err) {
// if there's no package.json (which is very unlikely), then do nothing

4
packages/create-astro/test/fixtures/not-empty/package.json vendored
View file

@ -2,6 +2,8 @@
"name": "@test/create-astro-not-empty",
"private": true,
"scripts": {
"build": "astro build"
"dev": "astro dev",
"build": "astro check && astro build",
"preview": "astro preview"
}
}

4
packages/create-astro/test/fixtures/not-empty/tsconfig.json vendored
View file

@ -1 +1,3 @@
{}
{
"extends": "astro/tsconfigs/strictest"
}

20
packages/create-astro/test/typescript.test.js
View file

@ -84,6 +84,8 @@ describe('typescript', () => {
});
describe('typescript: setup tsconfig', () => {
beforeEach(() => resetFixtures());
it('none', async () => {
const root = new URL('./fixtures/empty/', import.meta.url);
const tsconfig = new URL('./tsconfig.json', root);
@ -92,8 +94,6 @@ describe('typescript: setup tsconfig', () => {
expect(JSON.parse(fs.readFileSync(tsconfig, { encoding: 'utf-8' }))).to.deep.eq({
extends: 'astro/tsconfigs/strict',
});
await resetFixtures();
});
it('exists', async () => {
@ -103,20 +103,18 @@ describe('typescript: setup tsconfig', () => {
expect(JSON.parse(fs.readFileSync(tsconfig, { encoding: 'utf-8' }))).to.deep.eq({
extends: 'astro/tsconfigs/strict',
});
await resetFixtures();
});
});
describe('typescript: setup package', () => {
beforeEach(() => resetFixtures());
it('none', async () => {
const root = new URL('./fixtures/empty/', import.meta.url);
const packageJson = new URL('./package.json', root);
await setupTypeScript('strictest', { cwd: fileURLToPath(root), install: false });
expect(fs.existsSync(packageJson)).to.be.false;
await resetFixtures();
});
it('none', async () => {
@ -127,10 +125,12 @@ describe('typescript: setup package', () => {
'astro build'
);
await setupTypeScript('strictest', { cwd: fileURLToPath(root), install: false });
expect(JSON.parse(fs.readFileSync(packageJson, { encoding: 'utf-8' })).scripts.build).to.be.eq(
'astro check && astro build'
const { scripts } = JSON.parse(fs.readFileSync(packageJson, { encoding: 'utf-8' }));
expect(Object.keys(scripts)).to.deep.eq(['dev', 'build', 'preview'], 'does not override existing scripts');
expect(scripts.build).to.eq(
'astro check && astro build',
'prepends astro check command'
);
await resetFixtures();
});
});

10
packages/create-astro/test/utils.js
View file

@ -33,18 +33,22 @@ export function setup() {
const resetEmptyFixture = () =>
fs.promises.rm(new URL('./fixtures/empty/tsconfig.json', import.meta.url));
const resetNotEmptyFixture = async () => {
const packagePath = new URL('./fixtures/not-empty/package.json', import.meta.url);
const tsconfigPath = new URL('./fixtures/not-empty/tsconfig.json', import.meta.url);
const packageJsonData = JSON.parse(await fs.promises.readFile(packagePath, { encoding: 'utf-8' }));
const overriddenPackageJson = Object.assign(
JSON.parse(await fs.promises.readFile(packagePath, { encoding: 'utf-8' })),
packageJsonData,
{
scripts: {
dev: 'astro dev',
build: 'astro build',
},
preview: 'astro preview'
}
}
);
)
return Promise.all([
fs.promises.writeFile(packagePath, JSON.stringify(overriddenPackageJson, null, 2), {