Merge pull request #8 from lokesh-coder/develop

Add support for workspace

Author: lokesh-coder

docs/gatsby-config.js

@@ -70,14 +70,8 @@ const githubAPIOptions = {
 				issues {
 					totalCount
 				}
-				stargazers(first: 100) {
-					edges {
-						node {
-							name
-							login
-							avatarUrl
-						}
-					}
+				stargazers {
+					totalCount
 				}
 				collaborators(first: 100) {
 					edges {

docs/src/components/sidebar.js

@@ -12,12 +12,12 @@ const MenuLinks = ({ allContent }) => {
           <li className="mb-1">
             <Link
               to={`${fm.path}`}
-              className="text-gray-600 font-medium flex text-base"
+              className="text-gray-600 font-medium flex text-base hover:text-gray-800 group"
               activeClassName="active text-primary"
               partiallyActive={true}
             >
               <i
-                className={`mr-3 text-lg text-gray-600 active:text-primary ri-${fm.icon}`}
+                className={`mr-3 text-lg text-gray-600 active:text-primary group-hover:text-gray-800 ri-${fm.icon}`}
               ></i>
               <span className="flex-1">{fields.title}</span>
               {fm.skip && <i class="ri-anchor-fill"></i>}

docs/src/markdown/docs/main/core/commands.md

@@ -12,7 +12,7 @@ Command is a core part of lesy. You can create and add commands in multiple ways
 - Run multi-level sub commands
 - Run another command programatically
 - Parse and validate arguments and flags
-- Use features from app or plugins
+- Use features and utils from app or plugins
 
 ### Types of commands
 
@@ -22,8 +22,8 @@ Command can be an `Object`, `Function` or `Class` .
 
 ```typescript
 {
-    name:"hello",
-    run:()=>console.log("Hello Buddy!")
+    name: "hello",
+    run: () => console.log("Hello Buddy!")
 }
 ```
 
@@ -92,21 +92,27 @@ export default {
 };
 ```
 
+> If you want to exclude one or more files, you can simply add `_` prefix to the file name. For example, `/commands/_greeting.js`
+
 ### Anatomy of command
 
-The only required properties for a command is `name` and `run` . Everything else is optional and used for other purposes.
+The only required property for a command is `run` . Everything else is optional.
 
 #### name
 
 It refers the name of the command. It should be unique and short. Hyphen `-` is allowed.
 
+#### description
+
+This is a command description used by help and other plugins.
+
 #### run
 
-This function or method will be executed when this command is triggered.
+It is a function which will be executed when this command is triggered.
 
 #### aliases
 
-Command can have multiple alias. Please make sure you are not using the same alias in the another command
+Command can have multiple aliases. Please make sure you are not using the same alias in the another command
 
 ```typescript
 {
@@ -124,14 +130,15 @@ Command can have multiple alias. Please make sure you are not using the same ali
 
 #### args
 
-These are the arguments schema. This has inbuild validation. [refer](foobar) [](/)Validator helper.
+These are the arguments schema. This has inbuild validation. [refer](foobar) Validator helper.
 
 ```typescript
 {
     name:"hello",
     args:{
         username:{
-            required:true
+            required:true,
+            requiredError:"Please provide username",
         },
         age:{}
     },
@@ -173,14 +180,14 @@ $ node bin/cmd hello // THROWS ERROR
 */
 ```
 
-#### extra
+#### additionalInfo
 
-This extra text will be used by other plugins and middlewares. Originally, use case is for showing extra info about the command in help or pilot command
+This extra text will be used by other plugins and middlewares. Originally, use case is for showing info about the command in help or pilot command
 
 ```typescript
 {
     name:"delete",
-    extra:"this command will delete all files. run with caution.",
+    additionalInfo:"this command will delete all files. run with caution.",
     run:()=>{}
 }
 ```
@@ -201,10 +208,6 @@ $ node bin/cmd generate component
 */
 ```
 
-#### description
-
-This is a command description used by help and other plugins.
-
 #### usage
 
 Sample usage code shown in the help command
@@ -246,6 +249,10 @@ The `run` method provides various data about the command and app.
 }
 ```
 
+#### data.utils
+
+todo
+
 ### Sub commands
 
 Commands can be nested multiple levels. If you want to make a sub-command, just add the parent name in `main` property. Other features of the command remains same for sub commands.
@@ -298,7 +305,7 @@ Please dont use parent name aliases
 
 ### Default command
 
-By default **lesy** look for command named `default` if no args supplied in the input. If you would like to run different command as a default command, set it in the config.
+By default **lesy** looks for command named `default` if no args supplied in the input. If you would like to run different command as a default command, set it in the config.
 
 ```typescript
 {

docs/src/markdown/docs/main/core/middlewares.md

@@ -4,7 +4,7 @@ path: /docs/core/middlewares
 icon: fire-fill
 ---
 
-Middlewares are special type of hooks, to inject new functionality or change tge behaviour of the command flow. For instance, if you want to redirect the command, or validate the middleware can be hooked in to specific points in the flow. Basically, they are simple functions which will be execute at the runtime.
+Middlewares are special type of hooks, to inject new functionality or change the behaviour of the command flow. For instance, if you want to redirect the command or validate, the middleware can be hooked in to specific points in the flow. Basically, they are simple functions which will be execute at specific point during runtime.
 
 ### Hook points
 
@@ -34,11 +34,10 @@ export default {
 Add the middleware file in the **index.ts** file.
 
 ```typescript
-let argv = process.argv.slice(2);
 let commands = [...];
 let middlewares = [`${__dirname}/middlewares/start.ts`];
 
-export { argv, commands, middlewares };
+export { commands, middlewares };
 ```
 
 Middleware should return the input data to continue the flow.
@@ -76,9 +75,9 @@ This will run after loading all commands and plugins. The run context will have
 ```typescript
 export default {
   on: "START",
-  run: (data) => {
-    console.log(data.cmds);
-    return data;
+  run: (ctx) => {
+    console.log(ctx.cmds);
+    return ctx;
   },
 };
 ```
@@ -90,14 +89,14 @@ This will run before parsing raw argv input. At this point you can change **argv
 ```typescript
 export default {
   on: "PRE_PARSE",
-  run: (data) => {
-    // data.argv    - raw input argv values
-    // data.root    - root path
-    // data.config  - config object
-    // data.utils   - colors() and spinner() object
-    // data.feature - all features
-    // data.request - oject of dynamic actions
-    return data;
+  run: (ctx) => {
+    // ctx.argv    - raw input argv values
+    // ctx.root    - root path
+    // ctx.config  - config object
+    // ctx.utils   - colors() and spinner() object
+    // ctx.feature - all features
+    // ctx.request - oject of dynamic actions
+    return ctx;
   },
 };
 ```
@@ -109,17 +108,17 @@ Run after parsing raw argv values.
 ```typescript
 export default {
   on: "PRE_PARSE",
-  run: (data) => {
-    // data.argv    - raw input argv values
-    // data.root    - root path
-    // data.config  - config object
-    // data.utils   - colors() and spinner() object
-    // data.feature - all features
-    // data.request - oject of dynamic actions
-
-    // data.args    - resolved args
-    // data.flags   -  resolved flags
-    return data;
+  run: (ctx) => {
+    // ctx.argv    - raw input argv values
+    // ctx.root    - root path
+    // ctx.config  - config object
+    // ctx.utils   - colors() and spinner() object
+    // ctx.feature - all features
+    // ctx.request - oject of dynamic actions
+
+    // ctx.args    - resolved args
+    // ctx.flags   -  resolved flags
+    return ctx;
   },
 };
 ```
@@ -131,9 +130,9 @@ Once lesy found the right command to execute, it will pass the command object to
 ```typescript
 export default {
   on: "PRE_VALIDATE",
-  run: (data) => {
-    console.log(data);
-    return data;
+  run: (ctx) => {
+    console.log(ctx);
+    return ctx;
   },
 };
 ```
@@ -171,30 +170,31 @@ After validation passes, **pre_run** will be executed will all the necessary inf
 ```typescript
 export default {
   on: "PRE_RUN",
-  run: (data) => {
-    // data.argv    - raw input argv values
-    // data.root    - root path
-    // data.config  - config object
-    // data.utils   - colors() and spinner() object
-    // data.feature - all features
-    // data.request - oject of dynamic actions
-    // data.args    - resolved args
-    // data.flags   -  resolved flags
-    // data.rest   -  unknown args
-    return data;
+  run: (ctx) => {
+    // ctx.argv    - raw input argv values
+    // ctx.root    - root path
+    // ctx.config  - config object
+    // ctx.utils   - colors() and spinner() object
+    // ctx.feature - all features
+    // ctx.request - oject of dynamic actions
+    // ctx.args    - resolved args
+    // ctx.flags   -  resolved flags
+    // ctx.rest   -  unknown args
+    return ctx;
   },
 };
 ```
 
 ### END - Hook
 
-This hook will run at the end of the command flow. There is no run context. Thus no need of return statement.
+This hook will run at the end of the command flow.
 
 ```typescript
 export default {
   on: "END",
-  run: () => {
+  run: (ctx) => {
     console.log("Command ran successfully!");
+    return ctx;
   },
 };
 ```

docs/src/markdown/docs/main/core/testing.md

@@ -28,7 +28,7 @@ describe("CLI", () => {
     });
   });
 
-  it("should log proper outout", async () => {
+  it("should log proper output", async () => {
     let response = await testBed.run(["hello"]);
     expect(response).toContain("hello yoyo!");
   });

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

@@ -3,3 +3,7 @@ title: Concepts
 path: /docs/get-started/concepts
 icon: honour-fill
 ---
+
+Lesy is build based on frictionless sleek middleware architecture, thus maintaining the each core components work independently as well as play together.
+
+<img src="/images/concept.png" width="360"/>

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

@@ -4,9 +4,9 @@ path: /docs/get-started/installation
 icon: folder-download-fill
 ---
 
-Setting up Lesy is pretty simple and straightforward.
+Setting up Lesy is pretty simple and straightforward. And there are two ways to do that. Use **Lesy CLI** or do it manually.
 
-### Generate project with CLI
+### Scaffold project with CLI
 
 One easy way is using `npx` to generate project boilerplate with one command.
 
@@ -42,7 +42,7 @@ lesy my-cli --yes
 
 ### Project structure
 
-Here's how the project structure look like, after the project is generated
+Here's how the project structure look like, after the project is created
 
 ```
 my-cli
@@ -61,7 +61,7 @@ my-cli
 
 ### Manual setup
 
-Actually manual set up is also easy.
+If you are creating a simple CLI project and dont want too many directories, then its pretty simple.
 
 **Step 1**: Create new node project:
 
@@ -76,28 +76,35 @@ cd my-cli
 npm install @lesy/compiler
 ```
 
-**Step 3**: Create `executable` bin file `my-cli/bin/cmd`
+**Step 3**: Create main `index.(js|ts)` file
 
 ```js
 #!/usr/bin/env node
 
-const path = require("path");
 const lesy = require("@lesy/compiler");
 
 lesy({
-  root: path.resolve(__dirname, "../"),
-  commands:[...],
+  root: __dirname,
+  commands: [
+    {
+      name: "default",
+      run: () => console.log("hello"),
+    },
+    "./src/commands",
+  ],
   /* ...other props */
 }).parse();
 ```
 
-**Step 4**: Update executable file name in `package.json` file
+**Step 4**: Update bin property in `package.json` file
 
 ```json
 {
   "name": "my-cli",
   "bin": {
-    "mycli": "bin/cmd"
+    "mycli": "index.js"
   }
 }
 ```
+
+its done!