Skip to content

Commit

Permalink
feat(node): WIP Add docker
Browse files Browse the repository at this point in the history
  • Loading branch information
ndcunningham committed Jan 19, 2023
1 parent 2a294be commit a3873be
Show file tree
Hide file tree
Showing 11 changed files with 193 additions and 1 deletion.
8 changes: 8 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -5015,6 +5015,14 @@
"children": [],
"isExternal": false,
"disableCollapsible": false
},
{
"id": "setup-docker",
"path": "/packages/node/generators/setup-docker",
"name": "setup-docker",
"children": [],
"isExternal": false,
"disableCollapsible": false
}
],
"isExternal": false,
Expand Down
9 changes: 9 additions & 0 deletions docs/generated/manifests/packages.json
Original file line number Diff line number Diff line change
Expand Up @@ -1554,6 +1554,15 @@
"originalFilePath": "/packages/node/src/generators/library/schema.json",
"path": "/packages/node/generators/library",
"type": "generator"
},
"/packages/node/generators/setup-docker": {
"description": "Set up Docker configuration for a project.",
"file": "generated/packages/node/generators/setup-docker.json",
"hidden": false,
"name": "setup-docker",
"originalFilePath": "/packages/node/src/generators/setup-docker/schema.json",
"path": "/packages/node/generators/setup-docker",
"type": "generator"
}
},
"path": "/packages/node"
Expand Down
9 changes: 9 additions & 0 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -1531,6 +1531,15 @@
"originalFilePath": "/packages/node/src/generators/library/schema.json",
"path": "node/generators/library",
"type": "generator"
},
{
"description": "Set up Docker configuration for a project.",
"file": "generated/packages/node/generators/setup-docker.json",
"hidden": false,
"name": "setup-docker",
"originalFilePath": "/packages/node/src/generators/setup-docker/schema.json",
"path": "node/generators/setup-docker",
"type": "generator"
}
],
"githubRoot": "https://github.com/nrwl/nx/blob/master",
Expand Down
35 changes: 35 additions & 0 deletions docs/generated/packages/node/generators/setup-docker.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"name": "setup-docker",
"factory": "./src/generators/setup-docker/setup-docker",
"schema": {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"$id": "SchematicsNxSetupDocker",
"title": "Nx Node Docker Options Schema",
"description": "Nx Node Docker Options Schema.",
"type": "object",
"properties": {
"projectName": {
"description": "The name of the project",
"$default": { "$source": "argv", "index": 0 },
"type": "string"
},
"targetName": {
"description": "The name of the target environment",
"type": "string"
},
"buildTargetName": {
"description": "The name of the build Target",
"type": "string",
"default": "build"
}
},
"presets": []
},
"description": "Set up Docker configuration for a project.",
"hidden": false,
"implementation": "/packages/node/src/generators/setup-docker/setup-docker.ts",
"aliases": [],
"path": "/packages/node/src/generators/setup-docker/schema.json",
"type": "generator"
}
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"packages": ["build/packages/*"],
"version": "15.5.1",
"version": "15.6.0",
"granularPathspec": false,
"command": {
"publish": {
Expand Down
11 changes: 11 additions & 0 deletions packages/node/generators.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
"aliases": ["lib"],
"x-type": "library",
"description": "Create a node library."
},
"setup-docker": {
"factory": "./src/generators/setup-docker/setup-docker",
"schema": "./src/generators/setup-docker/schema.json",
"description": "Set up Docker configuration for a project.",
"hidden": false
}
},
"schematics": {
Expand All @@ -46,6 +52,11 @@
"aliases": ["lib"],
"x-type": "library",
"description": "Create a node library."
},
"setup-docker": {
"factory": "./src/generators/setup-docker/setup-docker#setupDockerGenerator",
"schema": "./src/generators/setup-docker/schema.json",
"description": "Set up Docker configuration for a project."
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FROM node:alpine

WORKDIR <%= app %>
COPY <%= buildLocation %> ./

RUN npm install
8 changes: 8 additions & 0 deletions packages/node/src/generators/setup-docker/schema.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export interface SetUpDockerOptions {
projectName?: string;
targetName?: string;
buildTarget?: string;
skipPackageJson?: boolean;
skipFormat?: boolean;
rootProject?: boolean;
}
24 changes: 24 additions & 0 deletions packages/node/src/generators/setup-docker/schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"$id": "SchematicsNxSetupDocker",
"title": "Nx Node Docker Options Schema",
"description": "Nx Node Docker Options Schema.",
"type": "object",
"properties": {
"projectName": {
"description": "The name of the project",
"$default": { "$source": "argv", "index": 0 },
"type": "string"
},
"targetName": {
"description": "The name of the target environment",
"type": "string"
},
"buildTargetName": {
"description": "The name of the build Target",
"type": "string",
"default": "build"
}
}
}
Empty file.
82 changes: 82 additions & 0 deletions packages/node/src/generators/setup-docker/setup-docker.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import {
addDependenciesToPackageJson,
convertNxGenerator,
formatFiles,
generateFiles,
GeneratorCallback,
joinPathFragments,
logger,
readNxJson,
readProjectConfiguration,
Tree,
updateProjectConfiguration,
} from '@nrwl/devkit';
import { runTasksInSerial } from '@nrwl/workspace/src/utilities/run-tasks-in-serial';
import { SetUpDockerOptions } from './schema';

function normalizeOptions(
tree: Tree,
setupOptions: SetUpDockerOptions
): SetUpDockerOptions {
return {
...setupOptions,
projectName: setupOptions.projectName ?? readNxJson(tree).defaultProject,
buildTarget: setupOptions.buildTarget ?? 'build',
};
}

function addDocker(tree: Tree, options: SetUpDockerOptions) {
const project = readProjectConfiguration(tree, options.projectName);
if (!project || !options.targetName) {
return;
}

if (tree.exists(joinPathFragments(project.root, 'DockerFile'))) {
logger.info(
`Skipping setup since a DockFile already exists inside ${project.root}`
);
}
const outputPath =
project.targets[`${options.buildTarget}`]?.options.outputPath;
generateFiles(tree, joinPathFragments(__dirname, './files'), project.root, {
tmpl: '',
app: project.sourceRoot,
buildLocation: outputPath,
});
}

export function updateProjectConfig(tree: Tree, options: SetUpDockerOptions) {
let projectConfig = readProjectConfiguration(tree, options.projectName);

const buildPort = Number(process.env.PORT) ?? 3000;

projectConfig.targets[`${options.targetName}`] = {
dependsOn: [`^${options.buildTarget}`],
executor: 'nx:run-commands',
options: {
commands: ['docker build .', `docker run -p ${buildPort}:${buildPort}`],
},
};

updateProjectConfiguration(tree, options.projectName, projectConfig);
}

export async function setupDockerGenerator(
tree: Tree,
setupOptions: SetUpDockerOptions
) {
const tasks: GeneratorCallback[] = [];
const options = normalizeOptions(tree, setupOptions);
// Should check if the node project exists
addDocker(tree, options);
updateProjectConfig(tree, options);

if (!options.skipFormat) {
await formatFiles(tree);
}

return runTasksInSerial(...tasks);
}

export default setupDockerGenerator;
export const setupDockerSchematic = convertNxGenerator(setupDockerGenerator);

0 comments on commit a3873be

Please sign in to comment.