meta: add prettier, .npmignore, and GitHub workflows

Author: null8626

.github/workflows/commit.yml

@@ -0,0 +1,28 @@
+name: Run ESLint, Prettier, and Tests
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - '**'
+    paths:
+      - '**/*.js'
+jobs:
+  test:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Installing dependencies
+        run: npm install
+      - name: Running Prettier
+        run: npx prettier **/*.js --write
+      - name: Commit
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: 'chore: prettier'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+package-lock.json

.npmignore

@@ -0,0 +1,3 @@
+.github/
+examples/
+plugins/

examples/consoleExample.js

@@ -1,68 +1,73 @@
-import { CommandHandler } from "../src/index.js";
+import { CommandHandler } from '../src/index.js';
 
 /*
 This example is a simple console commands handler
 */
 
 let handler = new CommandHandler({
-    prefix: "",
-    buildArguments: (build) => [build.args],
+  prefix: '',
+  buildArguments: build => [build.args]
 });
 
 handler.registerCommand({
-    name: "help",
-    desc: "Shows commands",
-    async run(args) {
-        handler.Commands.forEach((cmd) => {
-            console.log("> " + cmd.name);
-            console.log("  " + cmd.desc);
-            console.log("  Usage: " + handler.prettyPrint(cmd));
-        })
-    },
+  name: 'help',
+  desc: 'Shows commands',
+  async run(args) {
+    handler.Commands.forEach(cmd => {
+      console.log('> ' + cmd.name);
+      console.log('  ' + cmd.desc);
+      console.log('  Usage: ' + handler.prettyPrint(cmd));
+    });
+  }
 });
 
 handler.registerCommand({
-    name: "say",
-    desc: "Repeats your words",
-    args: [{
-        type: "text",
-        rest: true,
-    }],
-    async run([text]) {
-        // Because rest: true, it all gets collected to the first element
-        console.log(text);
-    },
+  name: 'say',
+  desc: 'Repeats your words',
+  args: [
+    {
+      type: 'text',
+      rest: true
+    }
+  ],
+  async run([text]) {
+    // Because rest: true, it all gets collected to the first element
+    console.log(text);
+  }
 });
 
 handler.registerCommand({
-    name: "add",
-    desc: "Add two numbers",
-    args: [{
-        type: "number",
-        name: "a",
-    }, {
-        type: "number",
-        name: "b",
-    }],
-    async run([a, b]) {
-        let sum = a + b;
-        console.log(a + " + " + b + " = " + sum);
+  name: 'add',
+  desc: 'Add two numbers',
+  args: [
+    {
+      type: 'number',
+      name: 'a'
     },
+    {
+      type: 'number',
+      name: 'b'
+    }
+  ],
+  async run([a, b]) {
+    let sum = a + b;
+    console.log(a + ' + ' + b + ' = ' + sum);
+  }
 });
 
 handler.registerCommand({
-    name: "exit",
-    desc: "Exit this example",
-    async run() {
-        console.log("OK, bye!");
-        process.exit();
-    },
+  name: 'exit',
+  desc: 'Exit this example',
+  async run() {
+    console.log('OK, bye!');
+    process.exit();
+  }
 });
 
 var stdin = process.openStdin();
-stdin.addListener("data", (d) => {
-    let input = d.toString().trim();
-    handler.run(input);
+stdin.addListener('data', d => {
+  let input = d.toString().trim();
+  handler.run(input);
 });
 
-handler.run("help");
+handler.run('help');

package-lock.json

@@ -30,5 +30,16 @@
   "homepage": "https://github.com/TheAlan404/string-commands#readme",
   "dependencies": {
     "splitargs": "^0.0.7"
+  },
+  "devDependencies": {
+    "prettier": "^2.6.2"
+  },
+  "prettier": {
+    "semi": true,
+	
+    "singleQuote": true,
+    "trailingComma": "none",
+    "arrowParens": "avoid",
+    "htmlWhitespaceSensitivity": "ignore"
   }
 }