Turn project into a Yeoman generator

Author: ywolff

.circleci/config.yml

@@ -4,95 +4,65 @@ orbs:
 
 jobs:
   install:
-    working_directory: ~/project-name
+    working_directory: ~/generator-sicarator
     docker:
-      - image: circleci/python:3.9.7
+      - image: circleci/node:16.12.0
     steps:
       - checkout
       # Download and cache dependencies
       - restore_cache:
           keys:
-            - project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
-      - run:
-          name: Update Poetry to version 1.1.10
-          command: |
-            curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python - --version 1.1.10
+            - generator-sicarator-dependencies-{{ checksum "package-lock.json" }}
+            # fallback to using the latest cache if no exact match is found
+            - generator-sicarator-dependencies-
       - run:
           name: Install dependencies
           command: |
-            source /home/circleci/.poetry/env
-            poetry run pip install --upgrade pip
-            poetry install
+            npm install
       - save_cache:
-          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+          key: generator-sicarator-dependencies-{{ checksum "package-lock.json" }}
           paths:
-            - /home/circleci/.cache/pypoetry/virtualenvs
-            - /home/circleci/.poetry/env
+            - node_modules
 
   test:
-    working_directory: ~/project-name
+    working_directory: ~/generator-sicarator
     docker:
-      - image: circleci/python:3.9.7
+      - image: circleci/node:16.12.0
     steps:
       - checkout
       - restore_cache:
-          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+          keys:
+            - generator-sicarator-dependencies-{{ checksum "package-lock.json" }}
+            - generator-sicarator-dependencies-
       - run:
-          name: run pytest
+          name: Run jest
           command: |
-            source /home/circleci/.poetry/env
-            make test
+            npm run test:ci
+          environment:
+                  JEST_JUNIT_OUTPUT_DIR: ./reports/junit/
       - store_test_results:
-          path: tests-results.xml
+          path: ./reports/junit/
       - store_artifacts:
-          path: htmlcov
-
-  black:
-    working_directory: ~/project-name
-    docker:
-      - image: circleci/python:3.9.7
-    steps:
-      - checkout
-      - restore_cache:
-          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
-      - run:
-          name: run black
-          command: |
-            source /home/circleci/.poetry/env
-            make black
+          path: ./reports/junit
 
   lint:
-    working_directory: ~/project-name
+    working_directory: ~/generator-sicarator
     docker:
-      - image: circleci/python:3.9.7
+      - image: circleci/node:16.12.0
     steps:
       - checkout
       - restore_cache:
-          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
-      - run:
-          name: run pylint
-          command: |
-            source /home/circleci/.poetry/env
-            make lint
-
-  isort:
-    working_directory: ~/project-name
-    docker:
-      - image: circleci/python:3.9.7
-    steps:
-      - checkout
-      - restore_cache:
-          key: project-name-poetry-1.1.10-{{ checksum "poetry.lock" }}
+          keys:
+            - generator-sicarator-dependencies-{{ checksum "package-lock.json" }}
+            - generator-sicarator-dependencies-
       - run:
-          name: run isort
+          name: Run eslint
           command: |
-            source /home/circleci/.poetry/env
-            make isort
-
+            npm run lint
 
 workflows:
   version: 2
-  project-name:
+  sicarator:
     jobs:
       - install
       - test:
@@ -101,9 +71,3 @@ workflows:
       - lint:
           requires:
             - install
-      - black:
-          requires:
-            - install
-      - isort:
-          requires:
-            - install

.eslintignore

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

.gitignore

@@ -1,19 +1,2 @@
-# byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-
-# unit tests / coverage reports
-/tests-results.xml
-/.coverage
-/coverage.xml
-/htmlcov/
-
-# pyenv
-/.python-version
-
-# IDE
-.idea/
-.vscode/
-
-# macOS
-.DS_Store
+node_modules
+coverage

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yannick Wolff <[email protected]>
+
+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.

README.md

@@ -1,77 +1,24 @@
-# {project-name}
-
-{project-description}
+# Sicarator
+> Sicara's project generator
 
 ## Installation
 
-To install this project, you need `Python 3.9.7`.
-The recommended way to install it is using [pyenv](https://github.com/pyenv/pyenv).
-
-### Install poetry
-
-```bash
-python -m pip install --upgrade pip
-pip install poetry==1.1.10
-```
-
-### Install requirements through poetry
-
-```bash
-poetry install --no-root
-```
-
-### Install git hooks (running before commit and push commands)
-
-```bash
-poetry run pre-commit install -t pre-commit
-poetry run pre-commit install -t pre-push
-```
-
-## Testing
-
-To run unit tests, run `pytest` with:
-```bash
-poetry run pytest tests --cov src
-```
-or
-```bash
-make test
-```
-
-## Formatting and static analysis
-
-### Code formatting with `black`
-
-To check code formatting, run `black` with:
-```bash
-poetry run black . --check
-```
-or
-```bash
-make black
-```
+- Install a stable version of [node.js](https://nodejs.org/) if you don't have one 
+- Install [Yeoman](http://yeoman.io):
+    ```bash
+    npm install -g yo
+    ```
+- Clone `sicarator` project and install it:
+    ```bas
+    git clone https://github.com/sicara/sicarator generator-sicarator
+    npm link generator-sicarator
+    ```
+    ⚠️ it has to be installed into a folder starting with `generator-` to be recognized as a generator by `Yeoman`
 
-You can also [integrate it to your IDE](https://black.readthedocs.io/en/stable/integrations/editors.html) to reformat
-your code each time you save a file.
+## Usage
 
-### Static analysis
+Generate a new project with:
 
-To run static analysis, run `pylint` with:
-```bash
-poetry run pylint src tests
-```
-or
-```bash
-make lint
-```
-
-### Imports ordering
-
-To check imports ordering, run `isort` with:
-```bash
-poetry run isort . --check
-```
-or
 ```bash
-make isort
+yo sicarator
 ```

__tests__/app.js

@@ -0,0 +1,17 @@
+"use strict";
+const path = require("path");
+const assert = require("yeoman-assert");
+const helpers = require("yeoman-test");
+
+describe("generator-sicarator:app", () => {
+  beforeAll(() => {
+    return helpers.run(path.join(__dirname, "../generators/app")).withPrompts({
+      projectName: "project-name",
+      projectDescription: "Project Description"
+    });
+  });
+
+  it("creates README.md", () => {
+    assert.file(["README.md"]);
+  });
+});

generators/app/index.js

@@ -0,0 +1,56 @@
+"use strict";
+const Generator = require("yeoman-generator");
+const chalk = require("chalk");
+const yosay = require("yosay");
+const path = require("path");
+const mkdirp = require("mkdirp");
+
+module.exports = class extends Generator {
+  prompting() {
+    // Have Yeoman greet the user.
+    this.log(
+      yosay(
+        `Hi, I'm ${chalk.red(
+          "Sicarator"
+        )}! I'm going to help you to set up your new project!`
+      )
+    );
+
+    const prompts = [
+      {
+        name: "projectName",
+        message: "What's the name of your project?",
+        default: path.basename(process.cwd())
+      },
+      {
+        name: "projectDescription",
+        message: "Describe it in one line:"
+      }
+    ];
+
+    return this.prompt(prompts).then(props => {
+      this.props = props;
+    });
+  }
+
+  default() {
+    if (path.basename(this.destinationPath()) !== this.props.projectName) {
+      this.log(`${chalk.green("create folder")} ${this.props.projectName}.`);
+      mkdirp.sync(this.props.projectName);
+      this.destinationRoot(this.destinationPath(this.props.projectName));
+    }
+  }
+
+  writing() {
+    this.fs.copyTpl(
+      this.templatePath(),
+      this.destinationPath(),
+      {
+        projectName: this.props.projectName,
+        projectDescription: this.props.projectDescription
+      },
+      {},
+      { globOptions: { dot: true } }
+    );
+  }
+};