backend-builders / backend-builder Goto Github PK

Expected Behavior

There should be an animation or other indication of processing during project installation.

Current Behavior

No loading or any feedback about the process.

Expected Behavior

Open source projects must have the Contribution Guidelines and Code of Conduct documents.

Current Behavior

Without documentation.

Expected Behavior

We need boilerplates in other languages and technologies and adapt the main code as needed.

Current Behavior

Only Node.js boilerplates and core functions adapted just for this environment.

Expected Behavior

The final output could have short instructions on how to access and run the project.

Current Behavior

Current output is just 'Project [project name] successfully created!'.

Expected Behavior

CLI prompts must have proper validation to verify that user input is valid (no blank, minimum characters, etc).

Current Behavior

No validation.

Possible Solution

Use the Inquirer validation property as exemplified here: https://github.com/SBoudrias/Inquirer.js/tree/master/packages/input

Expected Behavior

There should be a check if the directory with the project name already exists in the user's cwd

Current Behavior

No verification.

Expected Behavior

A proper README file must exist in the main project and in the boilerplates.

Current Behavior

No README files.

Expected Behavior

When creating a new project, the user will be able to choose the type of license through options in the CLI.

Current Behavior

No license files in boilerplates.

Possible Solution

Create a prompt with license options, copy the appropriate file and change the package.json

Expected Behavior

There should be an automated workflow for running tests on Pull Requests.

Current Behavior

No automation.

Possible Solution

Create a file similar to the ESLint workflow.

Expected Behavior

The main structure of the project should have tests covering user interactions with the CLI and other core functionality as performed by the file system module.

Current Behavior

No tests.

Sources:
https://github.com/SBoudrias/Inquirer.js/tree/master/packages/testing

Expected Behavior

The project should have files and settings for CI (Continuous Integration).

Current Behavior

No CI configuration.

Expected Behavior

Each functionality should be in separate modules for better readability and code maintenance.

Current Behavior

All code is in one file (index.js)

Expected Behavior

Node/Express boilerplates (with and without TypeScript) must have their first functionality tests.

Current Behavior

No tests.

Expected Behavior

The project name in package.json must be the same as the one chosen by the user.

Current Behavior

New projects have the same name as the boilerplate.

Expected Behavior

Dependencies should be installed automatically after transferring boilerplate directories and files.

Current Behavior

Installation is done manually with the command npm install

Possible Solution

Use the child_process module
https://stackabuse.com/executing-shell-commands-with-node-js/

Expected Behavior

The user should be given the option to provide details about the project, which will change in the package.json file (eg description, tags, etc)

Current Behavior

The option is unavailable.