@jsenv/cli 0.3.28 → 0.3.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/package.json +1 -1
  2. package/readme.md +33 -6
  3. package/template-node-package/package.json +1 -1
  4. package/template-web/package.json +1 -1
  5. package/template-web-components/package.json +1 -1
  6. package/template-web-preact/package.json +1 -1
  7. package/template-web-react/package.json +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsenv/cli",
3
- "version": "0.3.28",
3
+ "version": "0.3.29",
4
4
  "description": "Command Line Interface for jsenv",
5
5
  "license": "MIT",
6
6
  "repository": {
package/readme.md CHANGED
@@ -2,15 +2,25 @@
2
2
 
3
3
  [![npm package](https://img.shields.io/npm/v/@jsenv/cli.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/cli)
4
4
 
5
- _@jsenv/cli_ is a NPM package meant to run via the command below:
5
+ ## Overview
6
+
7
+ _@jsenv/cli_ is a command-line tool for quickly setting up JavaScript projects with jsenv configurations and best practices.
8
+
9
+ It provides templates for various project types to get you started immediately.
10
+
11
+ ## Installation & Usage
12
+
13
+ Run the CLI directly with npx:
6
14
 
7
15
  ```console
8
16
  npx @jsenv/cli
9
17
  ```
10
18
 
11
- > `npx` command is installed with Node.js. If you don't have it you must [install Node.js](https://nodejs.org/en/download/package-manager).
19
+ > `npx` command is installed with Node.js. If you don't have it, you must [install Node.js](https://nodejs.org/en/download/package-manager).
20
+
21
+ ## Getting Started
12
22
 
13
- The command init jsenv in a directory. It can be a new directory or an existing one.
23
+ The command initializes jsenv in a directory. It can be a new directory or an existing one.
14
24
 
15
25
  ```console
16
26
  > npx @jsenv/cli
@@ -18,7 +28,9 @@ Welcome in jsenv CLI
18
28
  ? Enter a directory: ›
19
29
  ```
20
30
 
21
- Then you'll be prompted to select a template.
31
+ ## Templates
32
+
33
+ After specifying a directory, you'll be prompted to select a template:
22
34
 
23
35
  ```console
24
36
  > npx @jsenv/cli
@@ -31,8 +43,15 @@ Then you'll be prompted to select a template.
31
43
  node-package
32
44
  ```
33
45
 
34
- A template is a project pre-configured with jsenv.
35
- Selecting "web" would init [template-web/](./template-web/):
46
+ ### Available Templates
47
+
48
+ - **web**: Basic web application with HTML, CSS, and JavaScript
49
+ - **web-components**: Project setup for creating reusable web components
50
+ - **web-react**: React-based web application configuration
51
+ - **web-preact**: Preact-based web application (lighter alternative to React)
52
+ - **node-package**: Configuration for creating a Node.js package
53
+
54
+ A template is a project pre-configured with jsenv. For example, selecting "web" would initialize the [web template](https://github.com/jsenv/core/tree/main/packages/related/cli/template-web):
36
55
 
37
56
  ```console
38
57
  > npx @jsenv/cli
@@ -45,3 +64,11 @@ npm install
45
64
  npm start
46
65
  -----------------------------
47
66
  ```
67
+
68
+ ## Next Steps
69
+
70
+ After initialization:
71
+
72
+ 1. Navigate to your project directory: `cd your-directory`
73
+ 2. Install dependencies: `npm install`
74
+ 3. Start the development server: `npm start`
package/template-node-package/package.json CHANGED
@@ -15,7 +15,7 @@
15
15
  "@jsenv/assert": "4.4.6",
16
16
  "@jsenv/core": "40.3.1",
17
17
  "@jsenv/eslint-config-relax": "1.4.10",
18
- "@jsenv/test": "3.6.12",
18
+ "@jsenv/test": "3.6.13",
19
19
  "eslint": "9.24.0",
20
20
  "prettier": "3.5.3"
21
21
  }
package/template-web/package.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "@jsenv/eslint-config-relax": "1.4.10",
21
21
  "@jsenv/plugin-bundling": "2.9.3",
22
22
  "@jsenv/plugin-minification": "1.6.3",
23
- "@jsenv/test": "3.6.12",
23
+ "@jsenv/test": "3.6.13",
24
24
  "eslint": "9.24.0",
25
25
  "open": "10.1.0",
26
26
  "@playwright/browser-chromium": "1.51.1",
package/template-web-components/package.json CHANGED
@@ -22,7 +22,7 @@
22
22
  "@jsenv/plugin-bundling": "2.9.3",
23
23
  "@jsenv/plugin-minification": "1.6.3",
24
24
  "@jsenv/eslint-config-relax": "1.4.10",
25
- "@jsenv/test": "3.6.12",
25
+ "@jsenv/test": "3.6.13",
26
26
  "eslint": "9.24.0",
27
27
  "open": "10.1.0",
28
28
  "@playwright/browser-chromium": "1.51.1",
package/template-web-preact/package.json CHANGED
@@ -26,7 +26,7 @@
26
26
  "@jsenv/plugin-bundling": "2.9.3",
27
27
  "@jsenv/plugin-minification": "1.6.3",
28
28
  "@jsenv/eslint-config-relax": "1.4.10",
29
- "@jsenv/test": "3.6.12",
29
+ "@jsenv/test": "3.6.13",
30
30
  "eslint": "9.24.0",
31
31
  "open": "10.1.0",
32
32
  "@playwright/browser-chromium": "1.51.1",
package/template-web-react/package.json CHANGED
@@ -27,7 +27,7 @@
27
27
  "@jsenv/plugin-bundling": "2.9.3",
28
28
  "@jsenv/plugin-minification": "1.6.3",
29
29
  "@jsenv/eslint-config-relax": "1.4.10",
30
- "@jsenv/test": "3.6.12",
30
+ "@jsenv/test": "3.6.13",
31
31
  "eslint": "9.24.0",
32
32
  "open": "10.1.0",
33
33
  "@playwright/browser-chromium": "1.51.1",