fix(vite): include vitest config in nodes plugin (#20887)

This commit is contained in:
Katerina Skroumpelou 2024-01-02 16:17:58 +02:00 committed by GitHub
parent d99e8e6aa5
commit f7d179522f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 136 additions and 144 deletions

View File

@ -36,9 +36,7 @@
"@nx/eslint": "file:../eslint",
"@nx/vue": "file:../vue"
},
"peerDependencies": {
"vite": "^5.0.0"
},
"peerDependencies": {},
"publishConfig": {
"access": "public"
}

View File

@ -124,8 +124,7 @@ describe('app', () => {
const projectConfi = readProjectConfiguration(tree, name);
expect(projectConfi.targets.build).toBeUndefined();
expect(projectConfi.targets.serve).toBeUndefined();
// TODO(katerina): Enable once `@nx/vite/plugin` is released
// expect(projectConfi.targets.test).toBeUndefined();
expect(projectConfi.targets.test).toBeUndefined();
});
});
});

View File

@ -32,6 +32,10 @@ describe('init', () => {
options: { buildTargetName: 'build', serveTargetName: 'serve' },
plugin: '@nx/nuxt/plugin',
},
{
options: { testTargetName: 'test' },
plugin: '@nx/vite/plugin',
},
]);
});
});

View File

@ -24,7 +24,7 @@ import { InitSchema } from '../schema';
export function updateDependencies(host: Tree, schema: InitSchema) {
let devDependencies: { [key: string]: string } = {
'@nx/nuxt': nxVersion,
'@nx/vite': nxVersion, // needed for the nxViteTsPaths plugin
'@nx/vite': nxVersion, // needed for the nxViteTsPaths plugin and @nx/vite/plugin
'@nuxt/devtools': nuxtDevtoolsVersion,
'@nuxt/kit': nuxtVersion,
'@nuxt/ui-templates': nuxtUiTemplatesVersion,
@ -64,23 +64,44 @@ export function addPlugin(tree: Tree) {
const nxJson = readNxJson(tree);
nxJson.plugins ??= [];
let hasNxNuxtPlugin = false;
let hasNxVitePlugin = false;
for (const plugin of nxJson.plugins) {
if (
typeof plugin === 'string'
? plugin === '@nx/nuxt/plugin'
: plugin.plugin === '@nx/nuxt/plugin'
) {
return;
hasNxNuxtPlugin = true;
}
if (
typeof plugin === 'string'
? plugin === '@nx/vite/plugin'
: plugin.plugin === '@nx/vite/plugin'
) {
hasNxVitePlugin = true;
}
}
nxJson.plugins.push({
plugin: '@nx/nuxt/plugin',
options: {
buildTargetName: 'build',
testTargetName: 'test',
serveTargetName: 'serve',
},
});
if (!hasNxNuxtPlugin) {
nxJson.plugins.push({
plugin: '@nx/nuxt/plugin',
options: {
buildTargetName: 'build',
serveTargetName: 'serve',
},
});
}
if (!hasNxVitePlugin) {
nxJson.plugins.push({
plugin: '@nx/vite/plugin',
options: {
testTargetName: 'test',
},
});
}
updateNxJson(tree, nxJson);
}

View File

@ -34,25 +34,6 @@ exports[`@nx/nuxt/plugin not root project should create nodes 1`] = `
"cwd": "my-app",
},
},
"test": {
"cache": true,
"command": "vitest run",
"inputs": [
"default",
"^production",
{
"externalDependencies": [
"vitest",
],
},
],
"options": {
"cwd": "my-app",
},
"outputs": [
"{workspaceRoot}/coverage/{projectRoot}",
],
},
},
},
},
@ -93,25 +74,6 @@ exports[`@nx/nuxt/plugin root project should create nodes 1`] = `
"cwd": ".",
},
},
"test": {
"cache": true,
"command": "vitest run",
"inputs": [
"default",
"^production",
{
"externalDependencies": [
"vitest",
],
},
],
"options": {
"cwd": ".",
},
"outputs": [
"{projectRoot}/coverage",
],
},
},
},
},

View File

@ -2,16 +2,6 @@ import { CreateNodesContext } from '@nx/devkit';
import { createNodes } from './plugin';
import { TempFs } from 'nx/src/internal-testing-utils/temp-fs';
jest.mock('vite', () => ({
loadConfigFromFile: jest.fn().mockImplementation(() => {
return Promise.resolve({
path: 'vite.config.ts',
config: {},
dependencies: [],
});
}),
}));
jest.mock('@nuxt/kit', () => ({
loadNuxtConfig: jest.fn().mockImplementation(() => {
return Promise.resolve({

View File

@ -16,7 +16,6 @@ import { existsSync, readdirSync } from 'fs';
import { loadNuxtKitDynamicImport } from '../utils/executor-utils';
import { calculateHashForCreateNodes } from '@nx/devkit/src/utils/calculate-hash-for-create-nodes';
import { getLockFileName } from '@nx/js';
import { loadConfigFromFile, UserConfig } from 'vite';
const cachePath = join(projectGraphCacheDirectory, 'nuxt.hash');
const targetsCache = existsSync(cachePath) ? readTargetsCache() : {};
@ -47,7 +46,6 @@ export const createDependencies: CreateDependencies = () => {
export interface NuxtPluginOptions {
buildTargetName?: string;
serveTargetName?: string;
testTargetName?: string;
}
export const createNodes: CreateNodes<NuxtPluginOptions> = [
@ -91,34 +89,13 @@ async function buildNuxtTargets(
options: NuxtPluginOptions,
context: CreateNodesContext
) {
let viteConfig:
| {
path: string;
config: UserConfig;
dependencies: string[];
}
| undefined;
if (
existsSync(
joinPathFragments(context.workspaceRoot, projectRoot, 'vitest.config.ts')
)
) {
viteConfig = await loadConfigFromFile(
{
command: 'build',
mode: 'production',
},
joinPathFragments(context.workspaceRoot, projectRoot, 'vitest.config.ts')
);
}
const nuxtConfig: {
buildDir: string;
} = await getInfoFromNuxtConfig(configFilePath, context, projectRoot);
const { buildOutputs, testOutputs } = getOutputs(
const { buildOutputs } = getOutputs(
nuxtConfig,
viteConfig?.config,
projectRoot
);
@ -135,12 +112,6 @@ async function buildNuxtTargets(
targets[options.serveTargetName] = serveTarget(projectRoot);
targets[options.testTargetName] = testTarget(
namedInputs,
testOutputs,
projectRoot
);
return targets;
}
@ -181,30 +152,6 @@ function serveTarget(projectRoot: string) {
return targetConfig;
}
function testTarget(
namedInputs: {
[inputName: string]: any[];
},
outputs: string[],
projectRoot: string
) {
return {
command: `vitest run`,
options: { cwd: projectRoot },
cache: true,
inputs: [
...('production' in namedInputs
? ['default', '^production']
: ['default', '^default']),
{
externalDependencies: ['vitest'],
},
],
outputs,
};
}
async function getInfoFromNuxtConfig(
configFilePath: string,
context: CreateNodesContext,
@ -226,18 +173,10 @@ async function getInfoFromNuxtConfig(
function getOutputs(
nuxtConfig: { buildDir: string },
viteConfig: UserConfig,
projectRoot: string
): {
buildOutputs: string[];
testOutputs: string[];
} {
const reportsDirectory = normalizeOutputPath(
viteConfig?.['test']?.coverage?.reportsDirectory,
projectRoot,
'coverage'
);
let nuxtBuildDir = nuxtConfig?.buildDir;
if (nuxtConfig?.buildDir && basename(nuxtConfig?.buildDir) === '.nuxt') {
// buildDir will most probably be `../dist/my-app/.nuxt`
@ -248,25 +187,23 @@ function getOutputs(
);
}
const buildOutputPath =
normalizeOutputPath(nuxtBuildDir, projectRoot, 'dist') ??
normalizeOutputPath(nuxtBuildDir, projectRoot) ??
'{workspaceRoot}/dist/{projectRoot}';
return {
buildOutputs: [buildOutputPath],
testOutputs: [reportsDirectory],
};
}
function normalizeOutputPath(
outputPath: string | undefined,
projectRoot: string,
path: 'coverage' | 'dist'
projectRoot: string
): string | undefined {
if (!outputPath) {
if (projectRoot === '.') {
return `{projectRoot}/${path}`;
return `{projectRoot}/dist`;
} else {
return `{workspaceRoot}/${path}/{projectRoot}`;
return `{workspaceRoot}/dist/{projectRoot}`;
}
} else {
if (isAbsolute(outputPath)) {
@ -285,6 +222,5 @@ function normalizeOptions(options: NuxtPluginOptions): NuxtPluginOptions {
options ??= {};
options.buildTargetName ??= 'build';
options.serveTargetName ??= 'serve';
options.testTargetName ??= 'test';
return options;
}

View File

@ -0,0 +1,32 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`@nx/vite/plugin root project should create nodes 1`] = `
{
"projects": {
".": {
"root": ".",
"targets": {
"test": {
"cache": true,
"command": "vitest run",
"inputs": [
"default",
"^production",
{
"externalDependencies": [
"vitest",
],
},
],
"options": {
"cwd": ".",
},
"outputs": [
"{projectRoot}/coverage",
],
},
},
},
},
}
`;

View File

@ -0,0 +1,48 @@
import { CreateNodesContext } from '@nx/devkit';
import { createNodes } from './plugin';
import { TempFs } from 'nx/src/internal-testing-utils/temp-fs';
jest.mock('vite', () => ({
loadConfigFromFile: jest.fn().mockImplementation(() => {
return Promise.resolve({
path: 'vitest.config.ts',
config: {},
dependencies: [],
});
}),
}));
describe('@nx/vite/plugin', () => {
let createNodesFunction = createNodes[1];
let context: CreateNodesContext;
describe('root project', () => {
beforeEach(async () => {
context = {
nxJsonConfiguration: {
targetDefaults: {},
namedInputs: {
default: ['{projectRoot}/**/*'],
production: ['!{projectRoot}/**/*.spec.ts'],
},
},
workspaceRoot: '',
};
});
afterEach(() => {
jest.resetModules();
});
it('should create nodes', async () => {
const nodes = await createNodesFunction(
'vitest.config.ts',
{
testTargetName: 'test',
},
context
);
expect(nodes).toMatchSnapshot();
});
});
});

View File

@ -52,7 +52,7 @@ export const createDependencies: CreateDependencies = () => {
};
export const createNodes: CreateNodes<VitePluginOptions> = [
'**/vite.config.{js,ts}',
'**/{vite,vitest}.config.{js,ts}',
async (configFilePath, options, context) => {
const projectRoot = dirname(configFilePath);
// Do not create a project if package.json and project.json isn't there.
@ -109,16 +109,20 @@ async function buildViteTargets(
const targets: Record<string, TargetConfiguration> = {};
targets[options.buildTargetName] = await buildTarget(
options.buildTargetName,
namedInputs,
buildOutputs,
projectRoot
);
if (!configFilePath.includes('vitest.config')) {
targets[options.buildTargetName] = await buildTarget(
options.buildTargetName,
namedInputs,
buildOutputs,
projectRoot
);
targets[options.serveTargetName] = serveTarget(projectRoot);
targets[options.serveTargetName] = serveTarget(projectRoot);
targets[options.previewTargetName] = previewTarget(projectRoot);
targets[options.previewTargetName] = previewTarget(projectRoot);
targets[options.serveStaticTargetName] = serveStaticTarget(options) as {};
}
targets[options.testTargetName] = await testTarget(
namedInputs,
@ -126,8 +130,6 @@ async function buildViteTargets(
projectRoot
);
targets[options.serveStaticTargetName] = serveStaticTarget(options) as {};
return targets;
}