ibbatta / readme-generator Goto Github PK

A well structured path for the project is needed in order to follow a roadmap and release a first 1.0 version of the project.

External / extra help will be appreciated.

Describe the bug
I tried to run the package with npx, but it fails with the error Cannot read property 'name' of null

To Reproduce
Steps to reproduce the behavior:

1. Just run npx readme-generator

Expected behavior
It should start the generator

Desktop (please complete the following information):

• OS: Mac OSX Mojave 10.14.6

For this #hacktoberfest event I am looking for someone who help me fixing my readme.md (if needed).

Feel free to open everything you want to grab the t-shirt (I will accept only useful pr)
(please also support me ---> click on the ⭐ and I will love you more <3)

FOLLOW THE HOW TO CONTRIBUTE PARAGRAPH FOR THE PULL REQUESTS

At the moment there are no fallbacks if package.json is missing or not readable.
Must provide some questions to collect crucial informations to generate a good looking README.md

It would be nice to have some tests inside code

Using XSTATE.js to handle the state chart for managing the steps.

Is your feature request related to a problem? Please describe.
This generator could be used for non-node projects.

Describe the solution you'd like
A shell flag to choose the configuration json location and an option for generic package manager .
It is ok to use the package.json format, but in a different project, like python project, I could have a readme.json file used only by generator.

Update README file, specifing best way to write a package.json to be parsed correctly

Describe the bug
The package uses @babel/polyfill, which has been deprecated from babel 7.4.0

To Reproduce
Just npm install

No need to use @babel/polyfill anymore, you can simply use regenerator-runtime/runtime and core-js/stable instead

It's important to dinamically add questions based on existent formatter files.
Also ask the user what kind of package manager he's using

I must think to a solution to minify the code and generate a more performant npm package for a production environment

Must be create a well-written README.md for the project.

Look like are missing some icons for the What this boilerplate contains section

It would be useful to use flags while run the tool to manage some options, for example:

• readme-generator -o to choose output file name
• readme-generator -y to choose all questions defaults value
  etc...

Read the npm documentation in order to learn how to develop and test locally a npm package.

Find a solution to develop a local and global npm cli to generate readme.

For this #hacktoberfest event I am looking for someone who help me checking the code and helping me with these tasks:

• check js files and, in case, apply a refactory for "good practices" and performance
• check test files and, in case, apply a refactory for "good practices" and performance
• check project trees and, in case, apply a refactory for "good practices"

Feel free to open everything you want to grab the t-shirt (I will accept only useful pr)
(please also support me ---> click on the ⭐ and I will love you more <3)

FOLLOW THE HOW TO CONTRIBUTE PARAGRAPH FOR THE PULL REQUESTS

Hi @ibbatta... Great job! But I have some advices to improve your generator.
I have seen that you have issues about unit tests, more option, and so on.
Therefore I recommend you to convert your generator as a yeoman project, in order to resolve some problems using standard tools and solutions.
You can emulate some of my projects, and in particular my api generator.
For any questions, feel you free to ask me, I will be very happy to share my experience about javascript and open source world :)

Check if there are more than one template inside the correct folder and then ask with inquirer what template you want to use (and then parse the right template)

Describe the bug
I cannot run version 0.1.1 when installed globally.

To Reproduce
Steps to reproduce the behavior:

1. npm install -g @ibbatta/[email protected]
2. readme-generator
3. See error

internal/modules/cjs/loader.js:628
    throw err;
    ^

Error: Cannot find module '../internals/to-indexed-object'
Require stack:
- /usr/local/lib/node_modules/@ibbatta/readme-generator/dist/index.js
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:625:15)
    at Function.Module._load (internal/modules/cjs/loader.js:527:27)
    at Module.require (internal/modules/cjs/loader.js:683:19)
    at require (internal/modules/cjs/helpers.js:16:16)
    at Object.<anonymous> (/usr/local/lib/node_modules/@ibbatta/readme-generator/dist/index.js:2:207)
    at Module._compile (internal/modules/cjs/loader.js:777:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:788:10)
    at Module.load (internal/modules/cjs/loader.js:643:32)
    at Function.Module._load (internal/modules/cjs/loader.js:556:12)
    at Function.Module.runMain (internal/modules/cjs/loader.js:840:10) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/usr/local/lib/node_modules/@ibbatta/readme-generator/dist/index.js'
  ]
}

Desktop (please complete the following information):

• OS: [MacOS Mojave]
• Version [10.14.6]

Additional context
Downgrading to 0.0.1 or 0.1.0 it works