Merge pull request #16 from eKhattak/canary

v1.2.0

Author: khattakdev

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: NPM Publish
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Pubish
+    runs-on: ubuntu-latest,
+    steps:
+      - name: ⏬ checkout
+        uses: actions/[email protected]
+      - name: 📦 Node
+        uses: actions/[email protected]
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org
+      - name: 🚀 Publish
+        run: npm publish --access publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

.npmignore

@@ -0,0 +1,102 @@
+ See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+out/*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+.sass-cache
+connect.lock
+typings
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Lerna
+lerna-debug.log
+
+# System Files
+.DS_Store
+Thumbs.db
+
+/src
+/bin
+/template
+/.vscode
+
+./src
+./bin
+./template
+./.vscode

demo.gif assets/demo.gifdemo.gif renamed to assets/demo.gif

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
 
-const cli = require("../src/cli");
-
+import cli from "../src/cli";
 cli(process.argv);

bin/index.js bin/index.tsbin/index.js renamed to bin/index.ts

@@ -1,10 +1,13 @@
 {
   "name": "mongoose-schema-cli",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "A MongoDB Schema Generator CLI",
   "main": "index.js",
+  "files": [
+    "dist"
+  ],
   "bin": {
-    "msc": "bin/index.js"
+    "msc": "dist/bin/index.js"
   },
   "repository": {
     "type": "git",
@@ -21,8 +24,10 @@
   "author": "Arsalan Khattak <[email protected]>",
   "license": "MIT",
   "dependencies": {
+    "@types/inquirer": "^7.3.0",
+    "@types/listr": "^0.14.2",
+    "@types/node": "^14.0.27",
     "arg": "^4.1.3",
-    "chalk": "^4.1.0",
     "inquirer": "^7.3.3",
     "listr": "^0.14.3"
   }

package-lock.json

@@ -21,7 +21,7 @@
 
 ### ✨ [Demo](https://github.com/eKhattak/mongoose-schema-cli)
 
-![Demo](/demo.gif)
+![Demo](/assets/demo.gif)
 
 ## Install
 

package.json

@@ -1,9 +1,13 @@
-const arg = require("arg");
-const inquirer = require("inquirer");
-const schema = require("./main");
-
-// export var schemaDetails = {};
-function parseArgumentsIntoOptions(rawArgs) {
+import arg from "arg";
+import inquirer from "inquirer";
+import createSchema from "./main";
+
+function parseArgumentsIntoOptions(
+  rawArgs: any[]
+): {
+  language: boolean;
+  filePath: string;
+} {
   const args = arg(
     {
       "--typescript": Boolean,
@@ -17,24 +21,39 @@ function parseArgumentsIntoOptions(rawArgs) {
     }
   );
   return {
-    language: args["--typescript"] || undefined,
+    language: args["--typescript"] || false,
     filePath: args["--filepath"] || "/",
   };
 }
 
-async function promptForMissingOptions(options) {
+type optionsType = {
+  language: boolean;
+  filePath?: string;
+  schemaKeys?: number | 0;
+};
+
+type questionType = {
+  type: string;
+  name: string;
+  message: string;
+  default: string | boolean | number;
+  choices?: string[] | number[];
+};
+
+async function promptForMissingOptions(
+  options: optionsType
+): Promise<{
+  language: any;
+  schema: any;
+  filePath?: string | undefined;
+  schemaKeys?: number | undefined;
+}> {
   const defaultOptions = {
     language: "Javascript",
     schema: "default",
   };
-  // if (options.skipPrompts) {
-  //   return {
-  //     ...options,
-  //     template: options.template || defaultLanguage,
-  //   };
-  // }
 
-  const questions = [];
+  const questions: questionType[] = [];
   //@TODO: Temporary Disabled, Uncomment after adding Typescript Schema
   // if (!options.language) {
   //   questions.push({
@@ -57,20 +76,18 @@ async function promptForMissingOptions(options) {
   return {
     ...options,
     language: options.language || answers.language,
-    mongoose: options.mongoose || answers.mongoose,
     schema: answers.schema,
   };
 }
 
 async function promptForSchemaObject() {
-  console.log();
   const defaultOptions = {
     name: "default",
     type: "String",
     required: true,
     default: "",
   };
-  const questions = [];
+  const questions: questionType[] = [];
 
   questions.push({
     type: "input",
@@ -101,18 +118,23 @@ async function promptForSchemaObject() {
     default: defaultOptions.default,
   });
 
-  const answers = await inquirer.prompt(questions);
+  const answers: {
+    name: string;
+    type: string;
+    required: boolean;
+    default: string;
+  } = await inquirer.prompt(questions);
 
   return {
-    schemaName: answers.name,
+    name: answers.name,
     type: answers.type,
     isRequired: answers.required,
     defaultValue: answers.default,
   };
 }
 
-async function cli(args) {
-  var options = parseArgumentsIntoOptions(args);
+async function cli(args: string[]) {
+  var options: optionsType = parseArgumentsIntoOptions(args);
   options = await promptForMissingOptions(options);
 
   const { schemaKeys } = await inquirer.prompt({
@@ -122,19 +144,20 @@ async function cli(args) {
     default: 0,
   });
 
-  // Get Schema Keys' Input
-  const schemaKeyValues = [];
+  const schemaKeyValues: {
+    name: string;
+    type: string;
+    isRequired: boolean;
+    defaultValue: string;
+  }[] = [];
   for (let i = 0; i < schemaKeys; i++) {
     const objectValues = await promptForSchemaObject();
     schemaKeyValues.push(objectValues);
   }
 
-  options = {
-    ...options,
-    schemaKeys,
-  };
+  var schema = { ...schemaKeys };
 
-  await schema(options, schemaKeyValues);
+  await createSchema(schema, schemaKeyValues);
 }
 
-module.exports = cli;
+export default cli;