Merge pull request #22 from lokesh-coder/develop

Develop

Author: lokesh-coder

README.md

@@ -14,16 +14,31 @@
 <h3 align="center">
 	> 𝙱𝚞𝚒𝚕𝚍 𝚖𝚘𝚍𝚎𝚛𝚗 𝚌𝚘𝚖𝚖𝚊𝚗𝚍-𝚕𝚒𝚗𝚎 𝚊𝚙𝚙𝚜_
 </h3>
+
 <p align="center">
 	<span>
 		<a href="https://lesyjs.io/">Website</a>
 		•
 		<a href="https://lesyjs.io/docs/get-started/overview">Documentation</a>
 		•
 		<a href="https://codesandbox.io/s/lesy-pilot-playground-hzjgw?file=/src/index.js">Playground</a>
+		•
+		<a href="https://twitter.com/lesyjs">Twitter</a>
 	</span>
 </p>
+
+<h1></h1>
 <br/>
+<p align="center">
+
+<img src="https://img.shields.io/coveralls/github/lokesh-coder/lesyjs?color=4a5874&labelColor=d5695f&style=flat-square"/>
+<img src="https://img.shields.io/github/workflow/status/lokesh-coder/lesyjs/Release?color=4a5874&labelColor=d5695f&style=flat-square"/>
+<img src="https://img.shields.io/npm/v/@lesy/core?color=4a5874&labelColor=d5695f&style=flat-square"/>
+<img src="https://img.shields.io/bundlephobia/minzip/@lesy/core?color=4a5874&labelColor=d5695f&label=core%20size%20&style=flat-square"/>
+<img src="https://img.shields.io/npm/dt/lesy?color=4a5874&labelColor=d5695f&style=flat-square"/>
+
+</p>
+
 <h1></h1>
 
 ## What is Lesy JS
@@ -74,8 +89,8 @@ Lesy can be installed from Lesy CLI or manually.
   Install `@lesy/compiler` via `npm` or `yarn`
 
   ```shell
-  mkdir my-cli && cd my-cli
-  npm install @lesy/compiler
+  > mkdir my-cli && cd my-cli
+  > npm install @lesy/compiler
   ```
 
   Then create a index file and add the below code
@@ -90,7 +105,7 @@ Lesy can be installed from Lesy CLI or manually.
   ```
 
   ```shell
-  ./index hello
+  > ./index hello
   ```
 
 ## Lesy core parts

docs/package-lock.json

@@ -18,41 +18,43 @@ Few things are considered as rules while developing,
 First lets see how the code is organised.
 
 ```bash
-lesy/
-┣ benchmark/
-┣ docs/
-┗ packages/
-  ┣ cli/
-  ┣ compiler/ # includes ts node if it is typescript project
-  ┣ core/ # handles user input and output
-  ┣ testbed/
-  ┣ types/
-  ┣ helpers/
-    ┗ validator/
-  ┣ misc/
-    ┣ pilot-ui/
-    ┗ test-utils/
-  ┗ plugins/
-    ┣ lesy-plugin-config/
-    ┣ lesy-plugin-demo/
-    ┣ lesy-plugin-generator/
-    ┣ lesy-plugin-help/
-    ┣ lesy-plugin-pilot/
-    ┣ lesy-plugin-prompt/
-    ┣ lesy-plugin-sidekick/
-    ┣ lesy-plugin-store/
-    ┗ lesy-plugin-validator/
+lesy
+├── benchmark/
+├── docs/
+└── packages/
+    ├── cli/
+    ├── compiler/ # includes ts node if it is typescript project
+    ├── core/ # handles user input and output
+    ├── testbed/
+    ├── types/
+    ├── helpers/
+    │   └── validator/
+    ├── misc/
+    │   ├── pilot-ui/
+    │   └── test-utils/
+    └── plugins/
+        ├── lesy-plugin-config/
+        ├── lesy-plugin-demo/
+        ├── lesy-plugin-generator/
+        ├── lesy-plugin-help/
+        ├── lesy-plugin-pilot/
+        ├── lesy-plugin-prompt/
+        ├── lesy-plugin-sidekick/
+        ├── lesy-plugin-store/
+        └── lesy-plugin-validator/
 ```
 
 There were around **18 packages** in the lesy framework. But what really matters is `core` and `compiler`, others are supporting features.
 
+> Below content is being updated with more examples and illustration.
+
 ### Core
 
 As the name says, it is the heart <i class="ri-heart-3-fill text-primary"></i> of the project. Main responsibility of the core is take user commands, convert them to objects and run them. Nothing more. It is slim, and can live without other things in the project.
 
 Core components include,
 
-#### Command Contoller
+#### [Command Contoller](https://github.com/lokesh-coder/lesyjs/blob/master/packages/core/src/command.ts)
 
 Takes commands, process and strore them in a nice format
 
@@ -78,26 +80,96 @@ Orchestrate all the above components and run commands and middlewares
 
 ### Compiler
 
+Compiler takes care of fewer tasks:
+
+- If it is typescript project, loads ts-node to run ts files
+- If src file is provided, loads all files provided and pass to core
+- Runs code module and pass args provided in parse
+- Loads default plugins
+- Sets default config
+- If global workspace value is set, it just returns core promise.
+
 ### Plugins
 
+Plugins directory consist of all lesy plugins
+
 ### Misc
 
+It consist of two packages, Pilot UI and test utils. Both packages are internally used and not published to npm.
+
+- Pilot UI is build with Angular and manages complete user interface logic. It is compiled and build by pilot plugin. Then the dist directory is served.
+
+- Test utils used inside few of the packages. It contains few helper methods.
+
 ### Testbed
 
+Used for integration test. Basically Testbed will run lesy with user provided data and collect all console output and returns.
+
 ### Types
 
+Contains all the type definition files of the core package.
+
 ### CLI
 
-### Helpers
+This package contains few lesy libraries and templates to scaffold new project based on the answers provided by users while initialising.
+
+Unlike other packages, lesy CLI is not part of @lesy organisation in the npm. This is because, if it is under @lesy scope, then user have to do `npx @lesy/cli new my-cli`. To improve the user and developer experience, CLI package has been moved out of lesy org.
+
+### Validator
+
+This package is used to validate a object against a rules defined in another object. It works independently and not coupled with lesy in any way.
+
+This library accepts custom rules.
+
+### Compile and Build
 
-### Build
+Lesy is build with node and typescript. And this project is maintained as a monorepo. Based on the need, either `ncc` or `tsc` compiler is used. `ncc` is mainly used to compress the file and reduce the size.
+
+[lerna]() is used to handle bootstraping and executing build script in all projects.
 
 ### Release
 
+[lerna]() is handle quite a few things here,
+
+- Versioning based on **conventional commits**
+- Release all packages to npm
+- Create tag and push to github
+- Create release notes in github
+- Update CHANGELOG file
+- Update the new version in all package.json files
+
 ### Docs
 
+Documentation is made using [gatsby](). All the markdown is build and published to `gh-pages` by the github actions.
+
 ### Pilot UI
 
+Pilot UI is a angular project. Basically Pilot command in lesy will exposes necessary data though web sockets and Pilot UI receives and display.
+
+When running command from UI, it send run signal and Pilot cmd runs the command and sends the ouput.
+
 ### Benchmark
 
+[benny]() is used for benchmarking. [commander](), [gluegun](), and [yargs]() are used for comparition. The output JSON is used in the Performance page to represent as bar chart.
+
 ### How it works
+
+<a href="/images/lesy-core-flow.png" target="_blank"><img src="/images/lesy-core-flow.png"/></a>
+
+**core** has two main methods. `bootstrap` and `run`
+
+**bootstrap(userData)**
+
+- Takes the user provided data(commands, featutes, etc.,)
+- Passes all data to loader to extract the content.
+- Extracted content is saved in state
+- Executes middlewares hooked to `INIT` and `START`
+
+**run(argv)**
+
+- Takes user provided command args from the terminal or from `parse` method
+- Parse arguments and flags
+- Find the correct command from the args
+- Validate args and flags
+- Run command
+- During this flow it executes middlewares hooked to `PRE_PARSE`, `POST_PARSE`, `PRE_VALIDATE`,`PRE_RUN`,`END`

docs/src/markdown/docs/dev/recipies/sample2.md

@@ -9,4 +9,9 @@ icon: lightbulb-flash-fill
 - Autocorrect mispelled args
 - Notification
 
+### Others
+
+- Support for desktop app
+- Allow pilot to show registered middlewares
+
 <!-- ### Improvement for Pilot plugin-->

docs/src/markdown/docs/main/develop/roadmap.md

@@ -11,7 +11,7 @@ Setting up Lesy is pretty simple and straightforward. And there are two ways to
 One easy way is using `npx` to generate project boilerplate with one command.
 
 ```shell
-npx lesy my-cli
+npx lesy new my-cli
 ```
 
 Alternatively you can install **Lesy** globally with `npm` or `yarn`.
@@ -34,10 +34,10 @@ This will ask you few questions like, is it typescript project, install pilot. I
 
 ```shell
 # with npx
-npx lesy my-cli --yes
+npx lesy new my-cli --yes
 
 # with global lesy
-lesy my-cli --yes
+lesy new my-cli --yes
 ```
 
 ### Project structure
@@ -82,18 +82,9 @@ npm install @lesy/compiler
 #!/usr/bin/env node
 
 const lesy = require("@lesy/compiler");
+const commands = [{ name: "hello", run: () => console.log("hello world") }];
 
-lesy({
-  root: __dirname,
-  commands: [
-    {
-      name: "default",
-      run: () => console.log("hello"),
-    },
-    "./src/commands",
-  ],
-  /* ...other props */
-}).parse();
+lesy({ commands }).parse();
 ```
 
 **Step 4**: Update bin property in `package.json` file

docs/src/markdown/docs/main/get-started/installation.md

@@ -64,7 +64,7 @@ p {
   @apply leading-none;
 }
 
-.content h4 a {
+.content h4 a.anchor {
   @apply hidden;
 }
 

docs/src/styles/tailwind.css

@@ -11,12 +11,19 @@
   "command": {
     "bootstrap": {
       "ignore": "@lesy/lesy-pilot-ui",
-      "npmClientArgs": [
-        "--no-package-lock"
-      ]
+      "npmClientArgs": ["--no-package-lock"]
     },
     "version": {
-      "message": "chore(release): 🎉 publish %s"
+      "message": "chore(release): 🎉 publish %s",
+      "ignoreChanges": [
+        "./docs/**",
+        "./benchmark/**",
+        "/coverage/**",
+        "**/__fixtures__/**",
+        "**/__tests__/**",
+        "**/*.md",
+        "**/package-lock.json"
+      ]
     }
   }
 }

docs/static/images/lesy-core-flow.png

@@ -89,6 +89,7 @@ Object {
     "getCommandById": [Function],
     "getCommandByName": [Function],
     "getCommands": [Function],
+    "getMiddlewares": [Function],
     "runCommand": [Function],
   },
   "root": StringContaining "/packages/core/__tests__",

lerna.json

@@ -103,17 +103,29 @@ describe("Core", () => {
     it("should get all middlewares", () => {
       expect(core["mwCtrl"].get()).toEqual({
         END: [
-          { on: "END", run: expect.any(Function) },
-          { on: "END", run: expect.any(Function) },
+          { on: "END", run: expect.any(Function), source: "__OBJ__" },
+          {
+            on: "END",
+            run: expect.any(Function),
+            source: `${__dirname}/plugin/middleware.js`,
+          },
+        ],
+        INIT: [{ on: "INIT", run: expect.any(Function), source: "__OBJ__" }],
+        POST_PARSE: [
+          { on: "POST_PARSE", run: expect.any(Function), source: "__OBJ__" },
         ],
-        INIT: [{ on: "INIT", run: expect.any(Function) }],
-        POST_PARSE: [{ on: "POST_PARSE", run: expect.any(Function) }],
         POST_RUN: [],
         POST_VALIDATE: [],
-        PRE_PARSE: [{ on: "PRE_PARSE", run: expect.any(Function) }],
-        PRE_RUN: [{ on: "PRE_RUN", run: expect.any(Function) }],
-        PRE_VALIDATE: [{ on: "PRE_VALIDATE", run: expect.any(Function) }],
-        START: [{ on: "START", run: expect.any(Function) }],
+        PRE_PARSE: [
+          { on: "PRE_PARSE", run: expect.any(Function), source: "__OBJ__" },
+        ],
+        PRE_RUN: [
+          { on: "PRE_RUN", run: expect.any(Function), source: "__OBJ__" },
+        ],
+        PRE_VALIDATE: [
+          { on: "PRE_VALIDATE", run: expect.any(Function), source: "__OBJ__" },
+        ],
+        START: [{ on: "START", run: expect.any(Function), source: "__OBJ__" }],
       });
     });
     it("should get config", () => {