Emily Xiong b377c96d99
feat(java): add gradle kotlin plugin (#29464)
- [x] change init to create `createNodes` instead
- [x] unit tests
- [x] test-ci
- [x] test on windows
- [x] help metadata
- [x] external nodes

TODO:
- add publish executor?
- publish to maven central?

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->
currently, it uses [project report
plugin](https://docs.gradle.org/current/userguide/project_report_plugin.html).
- pro: no need to maintain this plugin
- con: this plugin gives limited information

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
change the project report plugin to @nxn/gradle/plugin-v1
now the @nx/gradle plugin will use project graph plugin
(dev.nx.gradle.project-graph) created in this pr.
this plugin will create json file that is exactly what nx project grpah
expected.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2025-04-23 13:13:25 -04:00

106 lines
2.9 KiB
TypeScript

import {
CreateNodesV2,
CreateNodesContext,
ProjectConfiguration,
createNodesFromFiles,
readJsonFile,
writeJsonFile,
CreateNodesFunction,
workspaceRoot,
ProjectGraphExternalNode,
} from '@nx/devkit';
import { calculateHashForCreateNodes } from '@nx/devkit/src/utils/calculate-hash-for-create-nodes';
import { existsSync } from 'node:fs';
import { dirname, join } from 'node:path';
import { workspaceDataDirectory } from 'nx/src/utils/cache-directory';
import { hashObject } from 'nx/src/hasher/file-hasher';
import {
gradleConfigAndTestGlob,
splitConfigFiles,
} from '../utils/split-config-files';
import {
getCurrentProjectGraphReport,
populateProjectGraph,
} from './utils/get-project-graph-from-gradle-plugin';
import {
GradlePluginOptions,
normalizeOptions,
} from './utils/gradle-plugin-options';
type GradleTargets = Record<string, Partial<ProjectConfiguration>>;
function readProjectsCache(cachePath: string): GradleTargets {
return existsSync(cachePath) ? readJsonFile(cachePath) : {};
}
export function writeTargetsToCache(cachePath: string, results: GradleTargets) {
writeJsonFile(cachePath, results);
}
export const createNodesV2: CreateNodesV2<GradlePluginOptions> = [
gradleConfigAndTestGlob,
async (files, options, context) => {
const { buildFiles, gradlewFiles } = splitConfigFiles(files);
const optionsHash = hashObject(options);
const cachePath = join(
workspaceDataDirectory,
`gradle-${optionsHash}.hash`
);
const projectsCache = readProjectsCache(cachePath);
await populateProjectGraph(
context.workspaceRoot,
gradlewFiles.map((f) => join(context.workspaceRoot, f)),
options
);
const { nodes, externalNodes } = getCurrentProjectGraphReport();
try {
return createNodesFromFiles(
makeCreateNodesForGradleConfigFile(nodes, projectsCache, externalNodes),
buildFiles,
options,
context
);
} finally {
writeTargetsToCache(cachePath, projectsCache);
}
},
];
export const makeCreateNodesForGradleConfigFile =
(
projects: Record<string, Partial<ProjectConfiguration>>,
projectsCache: GradleTargets = {},
externalNodes: Record<string, ProjectGraphExternalNode> = {}
): CreateNodesFunction =>
async (
gradleFilePath,
options: GradlePluginOptions | undefined,
context: CreateNodesContext
) => {
const projectRoot = dirname(gradleFilePath);
options = normalizeOptions(options);
const hash = await calculateHashForCreateNodes(
projectRoot,
options ?? {},
context
);
projectsCache[hash] ??=
projects[projectRoot] ?? projects[join(workspaceRoot, projectRoot)];
const project = projectsCache[hash];
if (!project) {
return {};
}
project.root = projectRoot;
return {
projects: {
[projectRoot]: project,
},
externalNodes: externalNodes,
};
};