Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature Request: Initialize .projenrc.js with commented out project options #168

Closed
Chriscbr opened this issue Oct 7, 2020 · 2 comments · Fixed by #227
Closed

Feature Request: Initialize .projenrc.js with commented out project options #168

Chriscbr opened this issue Oct 7, 2020 · 2 comments · Fixed by #227

Comments

@Chriscbr
Copy link
Contributor

Chriscbr commented Oct 7, 2020

Quality of life / convenience feature.

The idea is when .projenrc.js gets generated, it should include a list of the available options out of the box, similar to how they are provided when you run tsc --init in a new repository, which produces:

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    ...

I see that jsii is being used to generate API docs right now -- maybe there's some way to hook into that or leverage it to perform this automatically?
@eladb
Copy link
Contributor

eladb commented Oct 7, 2020

Yes. This idea came to mind and should be achievable.

@pszabop
Copy link

pszabop commented Oct 11, 2020

Yes please. As a new user I'm finding it difficult to figure out what I can do. Any documentation help would be a plus.

@eladb eladb mentioned this issue Oct 12, 2020
Merged
@Chriscbr Chriscbr mentioned this issue Oct 24, 2020
Merged
@mergify mergify bot closed this as completed in #227 Nov 3, 2020
mergify bot pushed a commit that referenced this issue Nov 3, 2020
@Chriscbr
feat: initialize projenrc.js with commented options (#227)
b868fa3 
*Issue #, if available:* Closes #168 

*Description of changes:* Updated default rendering function for .projenrc.js config file so that it gets initialize with a list of all options available based on the project type.

Also updated the docstrings of several props so that the "default" field would be a proper value.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: initialize projenrc.js with commented options Chriscbr/projen
3 participants
@eladb @Chriscbr @pszabop