@dolphjs/cli 0.0.1-beta → 0.1.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <opensource-conduct@fb.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

package/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+Thank you for your interest in contributing to the DolphJs Docs!
+
+## Code of Conduct
+
+DolphJs has adopted a code of conduct that we expect contributors to adhere to.
+Please read the instructions in the [CODE_OF_CONDUCT](CODE_OF_CONDUCT) so
+you can understand our ethics.
+
+**Try to follow your own instructions.**
+
+When writing step-by-step instructions (e.g. how to install something), try to forget everything you know about the topic, and actually follow the instructions you wrote, a single step at time. Often you will discover that there is implicit knowledge that you forgot to mention, or that there are missing or out-of-order steps in the instructions. Bonus points for getting _somebody else_ to follow the steps and watching what they struggle with. Often it would be something very simple that you have not anticipated.
+
+## Guidelines for Code Examples
+
+### Syntax
+
+#### Prefer OOP to Functional Programming
+
+DolphJS is strictly built with the OOP approach.
+
+#### Use `const` where possible, otherwise `let`. Don't use `var`
+
+#### Don't use ES5 features when equivalent ES6 features have no downsides
+
+#### Don't forget to remove console.log's when finished with them
+
+#### Ensure that your code is scalable and uses the best implementation e.g prefer code with 0(n) to 0(logn)
+
+In particular, you should prefer arrow functions `const myFunction = () => ...` to named `functions` for top-level functions.
+
+### Style
+
+- Use semicolons.
+- No space between function names and parenthesis (`method() {}` not `method () {}`).
+- When in doubt, use the default style favored by [Prettier](https://prettier.io/playground/).
+
+### Highlighting
+
+Use `javascript` as the highlighting language in Markdown code blocks:
+
+````
+```javascript
+// code
+```
+````
+
+Sometimes you'll see blocks with numbers.  
+They tell the website to highlight specific lines.
+
+You can highlight a single line:
+
+````
+```javascipt {2}
+function hello() {
+  // this line will get highlighted
+}
+```
+````
+
+A range of lines:
+
+````
+```javascript {2-4}
+function hello() {
+  // these lines
+  // will get
+  // highlighted
+}
+```
+````
+
+Or even multiple ranges:
+
+````
+```javascript {2-4,6}
+function hello() {
+  // these lines
+  // will get
+  // highlighted
+  console.log('hello');
+  // also this one
+  console.log('there');
+}
+```
+````
+
+Be mindful that if you move some code in an example with highlighting, you also need to update the highlighting.
+
+Don't be afraid to often use highlighting! It is very valuable when you need to focus the reader's attention on a particular detail that's easy to miss.

package/new-app.mjs

@@ -29,7 +29,7 @@ import {
 const program = new Command();
 
 program
-  .version("1.0.0")
+  .version("0.1.0")
   .command("create-app <app-name>")
   .description("Create a new dolphJs application")
   .action(async (appName) => {
@@ -149,9 +149,9 @@ program
         const spinner2 = ora("Installing dev dependencies...").start();
 
         if (selectedOption === jsFunc || selectedOption === jsOop) {
-          exec(`${installCommand} ${devDependencies.join(" ")}`);
+          execSync(`${installCommand} ${devDependencies.join(" ")} -D`);
         } else if (selectedOption === tsFunc || selectedOption === tsOop) {
-          exec(`${installCommand} ${tsDevDependencies.join(" ")}`);
+          execSync(`${installCommand} ${tsDevDependencies.join(" ")} -D`);
         }
 
         spinner2.succeed("Dev dependencies installed!");
@@ -159,155 +159,10 @@ program
         // show completion message
         console.log(
           chalk.green(
-            `Done! Your app has been created. Navigate to your app by running "cd ${appName}" and then run ${chalk.bgGreen(
-              runMsg
-            )}`
-          )
-        );
-      } catch (error) {
-        console.log(chalk.redBright("\nError creating your app", error));
-      }
-    } catch (error) {
-      console.log(chalk.redBright("Error creating your app", error));
-    }
-  });
-
-program
-  .version("1.0.0")
-  .command("create-app <app-name>")
-  .description("Create a new dolphJs application")
-  .action(async (appName) => {
-    try {
-      console.log(
-        chalk.blueBright("Initializing your dolphJs application...") + "🐬"
-      );
-      const options = [tsOop, tsFunc, jsOop, jsFunc];
-      const { selectedOption } = await inquirer.prompt([
-        {
-          type: "list",
-          name: "selectedOption",
-          message: "How do you want to write your application ? 🤔:",
-          choices: options,
-        },
-      ]);
-
-      const packageManagerOptions = [npm, yarn, pnpm];
-      const { selectedPackageManagerOption } = await inquirer.prompt([
-        {
-          type: "list",
-          name: "selectedPackageManagerOption",
-          message: "Which is your preffered package manager ? :",
-          choices: packageManagerOptions,
-        },
-      ]);
-      console.info(chalk.green(`Using ${selectedPackageManagerOption}!`));
-      console.log(
-        chalk.green(`Getting your application ready for ${selectedOption}!`)
-      );
-      mkdirSync(appName);
-      process.chdir(appName);
-      if (selectedOption === tsOop) {
-        writeTsFilePackage(appName);
-        writeTsFileSwcrc();
-        writeGitignoreFile();
-        writeTsNodemonFile();
-        writeReadmeFile();
-        writeTsconfigFile();
-        mkdirSync("src");
-        mkdirSync("src/config");
-        mkdirSync("src/controllers");
-        mkdirSync("src/interfaces");
-        mkdirSync("src/routes");
-        writeTsOopSubFile();
-      }
-      if (selectedOption === tsFunc) {
-        writeTsFuncFilePackage(appName);
-        writeTsFileSwcrc();
-        writeGitignoreFile();
-        writeTsNodemonFile();
-        writeTsconfigFile();
-        writeReadmeFile();
-        mkdirSync("src");
-        mkdirSync("src/config");
-        mkdirSync("src/controllers");
-        mkdirSync("src/routes");
-        writeTsFuncSubFile();
-      }
-
-      if (selectedOption === jsFunc) {
-        writeJsFIlePackage(appName);
-        writeReadmeFile();
-        writeGitignoreFile();
-        mkdirSync("src");
-        mkdirSync("src/config");
-        mkdirSync("src/controllers");
-        mkdirSync("src/routes");
-        writeSubFileJsFunc();
-      }
-
-      if (selectedOption === jsOop) {
-        writeJsFIlePackage(appName);
-        writeReadmeFile();
-        writeGitignoreFile();
-        mkdirSync("src");
-        mkdirSync("src/config");
-        mkdirSync("src/controllers");
-        mkdirSync("src/routes");
-        writeSubFileJsOop();
-      }
-
-      // install dependencies using child process execSync
-      try {
-        const spinner = ora("Installing dependencies...").start();
-        let installCommand = "yarn add";
-        let runMsg = "yarn dev";
-
-        switch (selectedPackageManagerOption) {
-          case npm:
-            installCommand = "npm install";
-            runMsg = "npm run dev";
-            break;
-          case pnpm:
-            installCommand = "pnpm add";
-            runMsg = "pnpm dev";
-          case yarn:
-            installCommand = installCommand;
-          default:
-            break;
-        }
-
-        if (selectedOption === jsFunc || selectedOption === jsOop) {
-          execSync(`${installCommand} ${dependencies.join(" ")}`);
-        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
-          execSync(`${installCommand} ${tsDependencies.join(" ")}`);
-        }
-        spinner.succeed("Dependencies installed!");
-
-        // prompt user to select an option
-
-        // create app directory and copy files
-
-        // update package.json file
-        console.log(chalk.yellow("Updating package.json..."));
-        // install dev dependencies
-        const spinner2 = ora("Installing dev dependencies...").start();
-
-        if (selectedOption === jsFunc || selectedOption === jsOop) {
-          exec(`${installCommand} ${devDependencies.join(" ")}`);
-        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
-          exec(`${installCommand} ${tsDevDependencies.join(" ")}`);
-        }
-
-        spinner2.succeed("Dev dependencies installed!");
-
-        // show completion message
-        console.log(
-          chalk.green(
-            `Done! Your app has been created. Navigate to your app by running "cd ${appName}" and then run ${chalk.bgGreen(
-              runMsg
-            )}`
+            `Done! Your app has been created. Navigate to your app by running "cd ${appName}" and then run ${runMsg}`
           )
         );
+        process.exit(1);
       } catch (error) {
         console.log(chalk.redBright("\nError creating your app", error));
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dolphjs/cli",
-  "version": "0.0.1beta",
+  "version": "0.1.0",
   "description": "DolphJs is an express.js library for making software development easier by taking care of all the unneccessary tasks developers have to worry about.",
   "main": "new-app.mjs",
   "bin": {

package/utils/js-func/writeSubFile.mjs

@@ -15,7 +15,7 @@ module.exports = defaultRoutes;
 
 const demoRoutes =
   "const { Router } = require('@dolphjs/core');\n\
-const { sendMsg } = require('@/controllers/demo.controller');\n\
+const { sendMsg } = require('../controllers/demo.controller');\n\
 \
 const router = Router();\n\
 \
@@ -40,7 +40,7 @@ const controllerDemo = `const { httpStatus, catchAsync } = require('@dolphjs/cor
 
 const sendMsg = catchAsync(async (req, res) => {
 \tconst message =
-\t'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/\tcore#README.MD';
+\t'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/core#README.MD';
 \tres.status(httpStatus.OK).json({ message });
 });
 
@@ -77,14 +77,14 @@ module.exports = {\n\
 };\
 ";
 
-const jsConfigFile = `{
-  "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  }
-}
-`;
+// const jsConfigFile = `{
+//   "compilerOptions": {
+//     "paths": {
+//       "@/*": ["./src/*"]
+//     }
+//   }
+// }
+// `;
 
 export default function writeSubFileJsFunc() {
   writeFileSync("src/index.js", indexData);
@@ -92,5 +92,5 @@ export default function writeSubFileJsFunc() {
   writeFileSync("src/routes/demo.route.js", demoRoutes);
   writeFileSync("src/routes/index.js", indexRoute);
   writeFileSync("src/controllers/demo.controller.js", controllerDemo);
-  writeFileSync("jsConfig.json", jsConfigFile);
+  // writeFileSync("jsConfig.json", jsConfigFile);
 }

package/utils/js-oop/writeSubFileJsOop.mjs

@@ -2,7 +2,7 @@ import { writeFileSync } from "fs";
 
 const routeIndex =
   "const { Router } = require('@dolphjs/core');\n\
-const DemoController = require('@/controllers/demo.controller');\n\
+const DemoController = require('../controllers/demo.controller');\n\
 \n\
 class DemoRouter {\n\
 \tpath = '/v1/api';\n\
@@ -76,19 +76,19 @@ module.exports = {\n\
 };\
 ";
 
-const jsConfigFile = `{
-  "compilerOptions": {
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  }
-}
-`;
+// const jsConfigFile = `{
+//   "compilerOptions": {
+//     "paths": {
+//       "@/*": ["./src/*"]
+//     }
+//   }
+// }
+// `;
 
 export default function writeSubFileJsOop() {
   writeFileSync("src/index.js", indexData);
   writeFileSync("src/config/index.js", configIndex);
   writeFileSync("src/routes/demo.route.js", routeIndex);
   writeFileSync("src/controllers/demo.controller.js", controllerDemo);
-  writeFileSync("jsConfig.json", jsConfigFile);
+  // writeFileSync("jsConfig.json", jsConfigFile);
 }

package/utils/ts-func/copySubFolder.mjs

@@ -31,7 +31,7 @@ const sendGreeting = catchAsync(async (req: Request, res: Response) => {
 \tres.status(httpStatus.OK).send({ message });
 });
 
-export default { sendGreeting };\
+export { sendGreeting };\
 `;
 
 const demoRoute = `import { Router } from '@dolphjs/core'

package/utils/ts-oop/copySubFolder.mjs

@@ -27,7 +27,7 @@ import { AppRes, catchAsync, httpStatus } from '@dolphjs/core';
 class DemoAppController {
 \tpublic sendGreeting = catchAsync(async (req: Request, res: Response) => {
 \t  const message =
-\t  'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/\t  core#README.MD';
+\t  'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/core#README.MD';
 \t  res.status(httpStatus.OK).send({ message });
 \t});
 }