Replace generator-exercise with plop generator

generator-exercise/.editorconfig

@@ -1,11 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false

generator-exercise/.eslintignore

@@ -1,2 +0,0 @@
-coverage
-**/templates

generator-exercise/.gitattributes

@@ -1 +0,0 @@
-* text=auto

generator-exercise/.gitignore

@@ -1,2 +0,0 @@
-node_modules
-coverage

generator-exercise/.travis.yml

@@ -1,5 +0,0 @@
-language: node_js
-node_js:
-  - 7
-  - 6
-  - 4

generator-exercise/.yo-rc.json

@@ -1,9 +0,0 @@
-{
-  "generator-node": {
-    "promptValues": {
-      "authorName": "Cody Loyd",
-      "authorEmail": "codyloyd@gmail.com",
-      "authorUrl": "codyloyd.com"
-    }
-  }
-}

generator-exercise/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Cody Loyd <codyloyd@gmail.com> (codyloyd.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

generator-exercise/README.md

@@ -1,36 +0,0 @@
-# generator-exercise [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
-> generates boilerplate for The Odin Project exercises
-
-## Installation
-
-First, install [Yeoman](http://yeoman.io) and generator-exercise using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
-
-```bash
-npm install -g yo
-npm install -g generator-exercise
-```
-
-Then generate your new project:
-
-```bash
-yo exercise
-```
-
-## Getting To Know Yeoman
-
- * Yeoman has a heart of gold.
- * Yeoman is a person with feelings and opinions, but is very easy to work with.
- * Yeoman can be too opinionated at times but is easily convinced not to be.
- * Feel free to [learn more about Yeoman](http://yeoman.io/).
-
-## License
-
-MIT © [Cody Loyd](codyloyd.com)
-
-
-[npm-image]: https://badge.fury.io/js/generator-exercise.svg
-[npm-url]: https://npmjs.org/package/generator-exercise
-[travis-image]: https://travis-ci.org/codyloyd/generator-exercise.svg?branch=master
-[travis-url]: https://travis-ci.org/codyloyd/generator-exercise
-[daviddm-image]: https://david-dm.org/codyloyd/generator-exercise.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/codyloyd/generator-exercise

generator-exercise/generators/app/index.js

@@ -1,41 +0,0 @@
-'use strict';
-const Generator = require('yeoman-generator');
-const chalk = require('chalk');
-const yosay = require('yosay');
-
-module.exports = class extends Generator {
-  prompting() {
-    // Have Yeoman greet the user.
-    this.log(chalk.red('Let\'s do this'));
-
-    const prompts = [{
-      type: 'input',
-      name: 'title',
-      message: 'Enter the exercise title',
-      default: 'title'
-    }];
-
-    return this.prompt(prompts).then(props => {
-      // To access props later use this.props.someAnswer;
-      this.props = props;
-    });
-  }
-
-  writing() {
-    this.fs.copyTpl(
-      this.templatePath(`title.js`),
-      this.destinationPath(`${this.props.title}.js`),
-      {title: this.props.title}
-    );
-    this.fs.copyTpl(
-      this.templatePath(`title.spec.js`),
-      this.destinationPath(`${this.props.title}.spec.js`),
-      {title: this.props.title}
-    );
-    this.fs.copyTpl(
-      this.templatePath(`README.md`),
-      this.destinationPath(`README.md`),
-      {title: this.props.title}
-    );
-  }
-};

generator-exercise/generators/app/templates/README.md

@@ -1,2 +0,0 @@
-# Exercise XX - <%= title %>
-

generator-exercise/generators/app/templates/dummyfile.txt

@@ -1 +0,0 @@
-<%= title %>

generator-exercise/generators/app/templates/title.js

@@ -1,5 +0,0 @@
-let <%= title %> = function() {
-
-};
-
-module.exports = <%= title %>;

generator-exercise/generators/app/templates/title.spec.js

@@ -1,8 +0,0 @@
-let <%= title %> = require('./<%=title%>')
-
-describe('<%=title%>', function() {
-  test('EDITME', function() {
-    expect(<%=title%>()).toEqual(' ');
-  });
-
-});

generator-exercise/package.json

@@ -1,51 +0,0 @@
-{
-  "name": "generator-exercise",
-  "version": "0.0.0",
-  "description": "generates boilerplate for The Odin Project exercises",
-  "homepage": "theodinproject.com",
-  "author": {
-    "name": "Cody Loyd",
-    "email": "codyloyd@gmail.com",
-    "url": "codyloyd.com"
-  },
-  "files": [
-    "generators"
-  ],
-  "main": "generators/index.js",
-  "keywords": [
-    "lame",
-    "yeoman-generator"
-  ],
-  "devDependencies": {
-    "yeoman-test": "^1.6.0",
-    "yeoman-assert": "^3.0.0",
-    "nsp": "^3.2.1",
-    "eslint": "^4.1.0",
-    "eslint-config-xo-space": "^0.16.0",
-    "jest": "^19.0.2",
-    "jest-cli": "^20.0.0"
-  },
-  "dependencies": {
-    "chalk": "^1.1.3",
-    "extend": "^3.0.2",
-    "yeoman-generator": "^1.0.0",
-    "yosay": "^2.0.0"
-  },
-  "jest": {
-    "testEnvironment": "node"
-  },
-  "scripts": {
-    "prepublish": "nsp check",
-    "pretest": "eslint . --fix",
-    "test": "jest"
-  },
-  "eslintConfig": {
-    "extends": "xo-space",
-    "env": {
-      "jest": true,
-      "node": true
-    }
-  },
-  "repository": "git@github.com:TheOdinProject/javascript-exercises.git",
-  "license": "MIT"
-}

generators/helpers.js

@@ -0,0 +1,30 @@
+const { readdir } = require("fs/promises");
+
+function splitDirectoryName(directoryName) {
+  return {
+    exerciseNumber: directoryName.match(/\d+/),
+    exerciseName: directoryName.match(/[a-z]+/i),
+  };
+}
+
+async function getLatestExerciseDirectory() {
+  try {
+    const files = await readdir("./");
+    return files.findLast((file) => /^\d+_\w+$/.test(file));
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+async function createExerciseDirectoryName(directoryName) {
+  const latestExerciseDirectory = await getLatestExerciseDirectory();
+  const latestExerciseNumber = parseInt(latestExerciseDirectory.match(/^\d+/));
+
+  if (latestExerciseDirectory === `${latestExerciseNumber}_${directoryName}`) {
+    throw new Error(`Exercise already exists with name "${directoryName}"`);
+  }
+
+  return `${latestExerciseNumber + 1}_${directoryName}`;
+}
+
+module.exports = { createExerciseDirectoryName, splitDirectoryName };

generators/writeExercise.js

@@ -0,0 +1,24 @@
+const { writeFile } = require("fs/promises");
+const { join } = require("path");
+const { splitDirectoryName } = require("./helpers");
+
+async function writeExercise(exercisePath) {
+  const { exerciseName } = splitDirectoryName(exercisePath);
+  const isSolutionFile = exercisePath.includes("/solution");
+  const exerciseContent = `const ${exerciseName} = function() {
+  ${isSolutionFile ? "// Replace this comment with the solution code" : ""}
+};
+  
+// Do not edit below this line
+module.exports = ${exerciseName};`;
+
+  await writeFile(
+    join(
+      exercisePath,
+      `${exerciseName}${isSolutionFile ? "-solution" : ""}.js`
+    ),
+    exerciseContent
+  );
+}
+
+module.exports = { writeExercise };

generators/writeExerciseSpec.js

@@ -0,0 +1,34 @@
+const { writeFile } = require("fs/promises");
+const { join } = require("path");
+const { splitDirectoryName } = require("./helpers");
+
+async function writeExerciseSpec(exercisePath) {
+  const { exerciseName } = splitDirectoryName(exercisePath);
+  const isSolutionFile = exercisePath.includes("/solution");
+  const trueExerciseName = isSolutionFile
+    ? `${exerciseName}-solution`
+    : exerciseName;
+
+  const exerciseSpecContent = `const ${exerciseName} = require('./${trueExerciseName}');
+
+describe('${exerciseName}', () => {
+  test('First test description', () => {
+    // Replace this comment with any other necessary code, and update the expect line as necessary
+
+    expect(${exerciseName}()).toBe('');
+  });
+  
+  test${isSolutionFile ? "" : ".skip"}('Second test description', () => {
+    // Replace this comment with any other necessary code, and update the expect line as necessary
+
+    expect(${exerciseName}()).toBe('');
+  });
+});`;
+
+  await writeFile(
+    join(exercisePath, `${trueExerciseName}.spec.js`),
+    exerciseSpecContent
+  );
+}
+
+module.exports = { writeExerciseSpec };

generators/writeReadme.js

@@ -0,0 +1,14 @@
+const { writeFile } = require("fs/promises");
+const { join } = require("path");
+const { splitDirectoryName } = require("./helpers");
+
+async function writeReadme(exercisePath) {
+  const { exerciseNumber, exerciseName } = splitDirectoryName(exercisePath);
+  const readmeContent = `# Exercise ${exerciseNumber} - ${exerciseName}
+
+Description of the exercise goes here.`;
+
+  await writeFile(join(exercisePath, "README.md"), readmeContent);
+}
+
+module.exports = { writeReadme };

package.json

@@ -18,17 +18,19 @@
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.28.1",
     "jest": "^29.6.4",
-    "jest-cli": "^29.6.4"
+    "jest-cli": "^29.6.4",
+    "plop": "^4.0.1"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "generate": "plop"
   },
   "eslintConfig": {
     "root": true
   },
   "jest": {
     "testPathIgnorePatterns": [
-      "generator-exercise/"
+      "generators/"
     ]
   }
 }

plopFile.js

@@ -0,0 +1,43 @@
+const { mkdir } = require("fs/promises");
+const { join } = require("path");
+const { createExerciseDirectoryName } = require("./generators/helpers");
+const { writeReadme } = require("./generators/writeReadme");
+const { writeExercise } = require("./generators/writeExercise");
+const { writeExerciseSpec } = require("./generators/writeExerciseSpec");
+
+module.exports = function (plop) {
+  plop.setActionType("createExercise", async function (answers) {
+    const { exerciseName } = answers;
+    if (!exerciseName) {
+      throw new Error(
+        `Invalid exerciseName. Expected: valid string. Actual: "${exerciseName}"`
+      );
+    }
+
+    const exerciseDirectoryName = await createExerciseDirectoryName(
+      exerciseName
+    );
+    const basePath = join("./", exerciseDirectoryName);
+    const solutionPath = join(basePath, "solution");
+
+    await mkdir(basePath);
+    await mkdir(solutionPath);
+    await writeReadme(basePath);
+    await writeExercise(basePath);
+    await writeExercise(solutionPath);
+    await writeExerciseSpec(basePath);
+    await writeExerciseSpec(solutionPath);
+  });
+
+  plop.setGenerator("Basic", {
+    description: "Create a basic JavaScript exercise.",
+    prompts: [
+      {
+        type: "input",
+        name: "exerciseName",
+        message: "What is the name of the exercise? (camelCase)",
+      },
+    ],
+    actions: [{ type: "createExercise" }],
+  });
+};