Merge pull request #389 from the-hdr/main

generator-exercise: Update name

README.md

@@ -2,8 +2,6 @@
 
 These JavaScript exercises are intended to complement the JavaScript content on The Odin Project (TOP). They should only be done when instructed during the course of the curriculum.
 
-**Note:** The `generator-exercise` file is not actually an exercise; it is a script that generates exercises. It was created to help efficiently write these exercises.
-
 ## Contributing
 
 If you have a suggestion to improve an exercise, an idea for a new exercise, or notice an issue with an exercise, please feel free to open an issue after thoroughly reading our [contributing guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md).

exercise-generator/.editorconfig

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

exercise-generator/.eslintignore

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

exercise-generator/.gitattributes

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

exercise-generator/.gitignore

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

exercise-generator/.travis.yml

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

exercise-generator/.yo-rc.json

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

exercise-generator/LICENSE

@@ -0,0 +1,21 @@
+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.

exercise-generator/README.md

@@ -0,0 +1,36 @@
+# 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

exercise-generator/generators/app/index.js

@@ -0,0 +1,41 @@
+'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}
+    );
+  }
+};

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

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

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

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

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

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

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

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

exercise-generator/package.json

@@ -0,0 +1,51 @@
+{
+  "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": "^2.6.3",
+    "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"
+}