docs(examples): my-calculator

.changeset/js-dependsOn.md

@@ -2,5 +2,6 @@
 '@haetae/javascript': patch
 ---
 
+\
 - Support a glob pattern for `dependent` of `dependsOn()`.
 - Support glob patterns for `dependents` of `dependOn()`.

examples/cjs-js/README.md

@@ -2,7 +2,14 @@
 
 An example of using Haetae in CJS Javascript project.
 
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
 ```bash
-# Check if it works
 pnpm haetae helloworld
 ```

examples/cjs-ts-1/README.md

@@ -4,7 +4,14 @@ An example of using Haetae in CJS Typescript project.
 
 [`$TS_NODE_COMPILER_OPTIONS`](https://typestrong.org/ts-node/docs/options/#compileroptions) is used.
 
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
 ```bash
-# Check if it works
 pnpm haetae helloworld
 ```

examples/cjs-ts-2/README.md

@@ -4,7 +4,14 @@ An example of using Haetae in CJS Typescript project.
 
 A dedicated Typescript config *`tsconfig.haetae.json`* is used.
 
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
 ```bash
-# Check if it works
 pnpm haetae helloworld
 ```

examples/esm-js/README.md

@@ -2,7 +2,14 @@
 
 An example of using Haetae in ESM Javascript project.
 
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
 ```bash
-# Check if it works
 pnpm haetae helloworld
 ```

examples/esm-ts/README.md

@@ -2,7 +2,14 @@
 
 An example of using Haetae in ESM Typescript project.
 
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
 ```bash
-# Check if it works
 pnpm haetae helloworld
 ```

examples/my-calculator/README.md

@@ -1,3 +1,15 @@
 # my-calculator-test
 
 This is an example project guided by the official *Getting Started* docs.
+
+To execute, build the package [`heatae`](../../packages/haetae) first.
+
+```bash
+pnpm --filter "haetae" build
+```
+
+Then check if it works.
+
+```bash
+pnpm haetae tests
+```

packages/cli/package.json

@@ -22,6 +22,7 @@
     "lint": "eslint --ext .js,.cjs,.mjs,.jsx,.ts,.tsx,.md .",
     "lint:md": "markdownlint .",
     "build": "tsc --build tsconfig.build.json",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage -c ../../jest.config.js ./packages/cli/",
     "prepublishOnly": "tsc --build tsconfig.build.json"
   },
   "peerDependencies": {
@@ -52,7 +53,8 @@
     "@types/lodash.isobject": "^3.0.7",
     "@types/semver": "^7.5.0",
     "@types/signale": "^1.4.4",
-    "@types/yargs": "^17.0.24"
+    "@types/yargs": "^17.0.24",
+    "execa": "^8.0.1"
   },
   "keywords": [
     "haetae",

packages/cli/test/e2e.test.ts

@@ -0,0 +1,53 @@
+import { $ as $$ } from 'execa'
+import { dirname } from 'dirname-filename-esm'
+import upath from 'upath'
+
+const $ = $$({
+  stdio: 'pipe',
+})
+
+const examples = upath.resolve(dirname(import.meta), '../../../examples')
+
+describe('test', () => {
+  // eslint-disable-next-line jest/no-hooks
+  beforeAll(async () => {
+    await $`pnpm --filter "haetae" build`
+  })
+
+  test('cjs-js', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/cjs-js`,
+    })`pnpm haetae helloworld`
+    expect(stdout).toContain('Command helloworld is successfully executed.')
+  })
+  test('cjs-ts-1', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/cjs-ts-1`,
+    })`pnpm haetae helloworld`
+    expect(stdout).toContain('Command helloworld is successfully executed.')
+  })
+  test('cjs-ts-2', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/cjs-ts-2`,
+    })`pnpm haetae helloworld`
+    expect(stdout).toContain('Command helloworld is successfully executed.')
+  })
+  test('esm-js', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/esm-js`,
+    })`pnpm haetae helloworld`
+    expect(stdout).toContain('Command helloworld is successfully executed.')
+  })
+  test('esm-ts', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/esm-ts`,
+    })`pnpm haetae helloworld`
+    expect(stdout).toContain('Command helloworld is successfully executed.')
+  })
+  test('my-calculator', async () => {
+    const { stdout } = await $({
+      cwd: `${examples}/my-calculator`,
+    })`pnpm haetae test`
+    expect(stdout).toContain('Command test is successfully executed.')
+  })
+})

packages/haetae/readme.md

@@ -1,5 +1,5 @@
 # `haetae`
 
-The main user-friendly package recommended to most of users of Haetae.
+The main recommended user-friendly package for most of the users of Haetae.
 
 Refer to the official documentation website.