Feature: Basic CLI #24

oscar60310 · 2022-07-26T08:55:40Z

Description

Add CLI package and implement basic commands.

Implement commands: version, init, start, build, and serve.
Update package.json for all packages.
- add repo, license, and description fields.
- update dependency policies
Setup build and publish script (nx build xxx, nx publish xxx)

Testing

Use command nx install cli to build and install Vulcan from local, then run vulcan init to create new project.

codecov-commenter · 2022-08-18T01:43:22Z

Codecov Report

Merging #24 (e39b53b) into chore/init-ci (ed9a2d1) will decrease coverage by 0.31%.
The diff coverage is 87.25%.

@@                Coverage Diff                @@
##           chore/init-ci      #24      +/-   ##
=================================================
- Coverage          91.60%   91.28%   -0.32%     
=================================================
  Files                188      199      +11     
  Lines               2383     2594     +211     
  Branches             271      277       +6     
=================================================
+ Hits                2183     2368     +185     
- Misses               160      181      +21     
- Partials              40       45       +5

Impacted Files	Coverage Δ
.../template-engine/code-loader/inMemoryCodeLoader.ts	`100.00% <ø> (ø)`
packages/cli/src/commands/version.ts	`55.55% <55.55%> (ø)`
packages/cli/src/commands/init.ts	`83.33% <83.33%> (ø)`
packages/cli/src/utils/shutdown.ts	`87.50% <87.50%> (ø)`
packages/cli/src/cli.ts	`91.66% <91.66%> (ø)`
packages/cli/src/commands/build.ts	`92.30% <92.30%> (ø)`
packages/build/src/lib/vulcanBuilder.ts	`100.00% <100.00%> (ø)`
packages/cli/src/commands/index.ts	`100.00% <100.00%> (ø)`
packages/cli/src/commands/serve.ts	`100.00% <100.00%> (ø)`
packages/cli/src/commands/start.ts	`100.00% <100.00%> (ø)`
... and 4 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

- write some initial files for demo - fix in-memory code loader name

kokokuo

Thanks for adding cli package, LGTM 👍

kokokuo · 2022-08-18T09:11:16Z

tools/scripts/publish.mjs

@@ -0,0 +1,13 @@
+import { execSync } from 'child_process';
+
+if (process.env.READY_FOR_PUBLISH !== 'true') {


Great for adding READY_FOR_PUBLISH to prevent unnecessary enter publish 👍

kokokuo · 2022-08-18T09:44:06Z

packages/build/project.json

-        "assets": ["packages/build/*.md"]
-      }
+        "assets": ["packages/build/*.md"],
+        "buildableProjectDepsInPackageJsonType": "dependencies"


Is the property buildableProjectDepsInPackageJsonType could the nx automatically add dependencies and buildable libraries so that we could publish a library with all dependencies ? (nrwl/nx#4620)

if it is true, maybe you could add the comment to let others know the purpose so that we could remind it to add when we create new nx packages and would like to publish in the future?

https://nx.dev/packages/js/executors/tsc
The property updateBuildableProjectDepsInPackageJson control whether to add dependencies to package.json or not, its default value is true.

The setting here enforces the generator put these dependencies to "dependencies" but not "peerDependencies", ~~I'll add some comments to tell the reason~~

Update: We can't add comments in JSON file 🤣

Thanks @oscar60310 for answering my question, it was really helpful for me to understand its importance in the project.

That's fine. 😄 Still thanks for sharing the message, if there, I will memo it in my note.

kokokuo · 2022-08-18T10:13:56Z

packages/cli/src/commands/build.ts

+  config: string;
+}
+
+const defaultConfig: BuildCommandOptions = {


NIT: maybe you could rename to defaultOptions because the options contain config.

Sure, I'll update them.

kokokuo · 2022-08-18T10:15:34Z

packages/cli/src/commands/build.ts

+import * as jsYAML from 'js-yaml';
+import { promises as fs } from 'fs';
+import * as path from 'path';
+import * as ora from 'ora';


Wow, the cool package for showing running/loading style 😲

kokokuo · 2022-08-18T10:16:24Z

packages/cli/src/commands/serve.ts

+  port: number;
+}
+
+const defaultConfig: ServeCommandOptions = {


NIT: Same suggestion rename like above build

- add descriptions, license, repo ... for each package - use dependencies instead of peerdependencies of most dependency - set peerdependencise for Vulcan imports

oscar60310 · 2022-08-19T08:38:27Z

Hi @kokokuo All issues have been fixed besides the project.json comments~ thanks!

oscar60310 force-pushed the feature/cli branch from a02e410 to b2cfd97 Compare August 8, 2022 08:02

oscar60310 changed the base branch from develop to feature/extension-loader August 8, 2022 08:07

oscar60310 force-pushed the feature/cli branch 4 times, most recently from 0c3d144 to dc8b897 Compare August 12, 2022 07:19

oscar60310 force-pushed the feature/extension-loader branch from 58c8aa4 to 9bad6f1 Compare August 12, 2022 07:35

oscar60310 force-pushed the feature/cli branch 8 times, most recently from 140e5a7 to 074e8de Compare August 16, 2022 04:44

oscar60310 changed the title ~~[WIP] Feature: CLI~~ Feature: CLI Aug 17, 2022

oscar60310 changed the title ~~Feature: CLI~~ Feature: Basic CLI Aug 17, 2022

oscar60310 requested a review from kokokuo August 17, 2022 02:01

oscar60310 marked this pull request as ready for review August 17, 2022 02:01

Base automatically changed from feature/extension-loader to develop August 17, 2022 06:45

oscar60310 force-pushed the feature/cli branch 3 times, most recently from 33841c6 to e39b53b Compare August 18, 2022 01:38

oscar60310 changed the base branch from develop to chore/init-ci August 18, 2022 01:38

oscar60310 force-pushed the chore/init-ci branch from ed9a2d1 to f34c021 Compare August 18, 2022 02:40

oscar60310 force-pushed the feature/cli branch from e39b53b to c887048 Compare August 18, 2022 02:43

oscar60310 added 3 commits August 18, 2022 10:47

feat(cli): init cli package and add init command

35e5591

feat(cli, core): write some initial files for demo

4aee476

- write some initial files for demo - fix in-memory code loader name

fix(build): unite options injection

c4f96dc

oscar60310 added 2 commits August 18, 2022 10:47

feat(cli): implement start command

7b5b547

feat(cli): implement version command

a56dec7

oscar60310 force-pushed the feature/cli branch from c887048 to 128fdcd Compare August 18, 2022 02:47

Base automatically changed from chore/init-ci to develop August 18, 2022 07:47

kokokuo approved these changes Aug 18, 2022

View reviewed changes

oscar60310 added 8 commits August 19, 2022 16:31

feat(cli): implement build,serve commands

76e75f4

build: update nx config and package.json for every package

bb3e43d

- add descriptions, license, repo ... for each package - use dependencies instead of peerdependencies of most dependency - set peerdependencise for Vulcan imports

feat(cli): add command descriptions

703d4f1

feat(cli): catching sigint signal and close server before exit

d625fb8

build: release 0.1.0-alpha.1 for dev usage

87f5dbf

test(cli): add test cases for basic commands

ad667a4

fix(cli): fix glob search pattern on Windows

b045fe1

build(npm): fix dependencies issues

2f75878

oscar60310 force-pushed the feature/cli branch from 128fdcd to 2f75878 Compare August 19, 2022 08:31

test(cli): add test for version commands

49ad739

kokokuo merged commit dc2cf86 into develop Aug 19, 2022

kokokuo deleted the feature/cli branch August 19, 2022 11:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Basic CLI #24

Feature: Basic CLI #24

oscar60310 commented Jul 26, 2022 •

edited

Loading

codecov-commenter commented Aug 18, 2022

kokokuo left a comment •

edited

Loading

kokokuo Aug 18, 2022

kokokuo Aug 18, 2022

oscar60310 Aug 19, 2022 •

edited

Loading

kokokuo Aug 19, 2022

kokokuo Aug 18, 2022

oscar60310 Aug 19, 2022

kokokuo Aug 18, 2022

kokokuo Aug 18, 2022

oscar60310 commented Aug 19, 2022

		@@ -0,0 +1,13 @@
		import { execSync } from 'child_process';

		if (process.env.READY_FOR_PUBLISH !== 'true') {

Feature: Basic CLI #24

Feature: Basic CLI #24

Conversation

oscar60310 commented Jul 26, 2022 • edited Loading

Description

Testing

codecov-commenter commented Aug 18, 2022

Codecov Report

kokokuo left a comment • edited Loading

Choose a reason for hiding this comment

kokokuo Aug 18, 2022

Choose a reason for hiding this comment

kokokuo Aug 18, 2022

Choose a reason for hiding this comment

oscar60310 Aug 19, 2022 • edited Loading

Choose a reason for hiding this comment

kokokuo Aug 19, 2022

Choose a reason for hiding this comment

kokokuo Aug 18, 2022

Choose a reason for hiding this comment

oscar60310 Aug 19, 2022

Choose a reason for hiding this comment

kokokuo Aug 18, 2022

Choose a reason for hiding this comment

kokokuo Aug 18, 2022

Choose a reason for hiding this comment

oscar60310 commented Aug 19, 2022

oscar60310 commented Jul 26, 2022 •

edited

Loading

kokokuo left a comment •

edited

Loading

oscar60310 Aug 19, 2022 •

edited

Loading