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

jsii-config #904

Closed
1 of 2 tasks
eladb opened this issue Oct 23, 2019 · 1 comment · Fixed by #981
Closed
1 of 2 tasks

jsii-config #904

eladb opened this issue Oct 23, 2019 · 1 comment · Fixed by #981
Assignees
@MrArnoldPalmer
Labels
feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md

Comments

@eladb
Copy link
Contributor

eladb commented Oct 23, 2019

jsii-config is an interactive command line tool for creating jsii configuration in package.json.

Since writing the jsii config section in package.json can be a bit of a hassle and requires quite a lot of configuration, it will be nice to offer an interactive experience:

Proposed Solution

$ jsii-config
Configuring jsii for `my-module`.
Python (y/n)? y
    module - the name of the generated Python module (required): hello_jsii
    distName - the PyPI distribution name for the package (required): hello-jsii
Java (y/n)? y
    package - the root Java package name: acme.jsii.hello
    maven/groupId - group ID (required): acme
    maven/artifactId - artifact ID  (required): jsii-hello
    versionSuffix (optional):
...

Written `jsii` section in package.json.
  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request
@RomainMuller
Copy link
Contributor

I like the idea. And it'll also bridge a documentation/discoverability issue here.

The only twist I'd have is that I'd allow hitting to this command as jsii config as well, so discoverability is enhanced.

@RomainMuller RomainMuller transferred this issue from aws/aws-cdk Oct 23, 2019
@RomainMuller RomainMuller added feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md labels Oct 23, 2019
@MrArnoldPalmer MrArnoldPalmer self-assigned this Oct 29, 2019
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 12, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
0f6aeb3 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 12, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
956cc9f 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 13, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
8a17ec3 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
@MrArnoldPalmer MrArnoldPalmer mentioned this issue Nov 13, 2019
Merged
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 13, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
1fdf37b 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 14, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
e93882f 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
MrArnoldPalmer added a commit to MrArnoldPalmer/jsii that referenced this issue Nov 15, 2019
@MrArnoldPalmer
feat(jsii-config): Adds jsii-config Package
7f46377 
Defines jsii-config CLI application for configuring a jsii package's
`jsii` options inside package.json. These options dictate what target
languages and language specific packaging options jsii uses when
building.

The application uses [inquirer](https://www.npmjs.com/package/inquirer)
for interactive prompts and [yargs](https://www.npmjs.com/package/yargs)
for argument parsing.

jsii-config will help configure packages with or without an existing
jsii configuration in package.json. If the object does exist, the
default values of fields that are prompted will be the existing values.
This allows users to just hit 'enter' until they get to the options they
wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they
are asked to confirm the config. If the user selects 'yes', the config
is written to package.json, if they select 'no', they will be prompted
to fill out the fields again, however, the default values will now be
what they previously entered. This is done so the user will only need to
change the specific fields that need it.

Fixes aws#904
eladb pushed a commit that referenced this issue Nov 18, 2019
@MrArnoldPalmer
feat(jsii-config): introducing jsii-config (#981)
2bbf576 
Defines jsii-config CLI application for configuring a jsii package's jsii options inside package.json. These options dictate what target languages and language specific packaging options jsii uses when building.

The application uses inquirer for interactive prompts and yargs for argument parsing.

jsii-config will help configure packages with or without an existing jsii configuration in package.json. If the object does exist, the default values of fields that are prompted will be the existing values. This allows users to just hit 'enter' until they get to the options they wish to change and modify only those.

After the user inputs all of the values for the relevant prompts, they are asked to confirm the config. If the user selects 'yes', the config is written to package.json, if they select 'no', they will be prompted to fill out the fields again, however, the default values will now be what they previously entered. This is done so the user will only need to change the specific fields that need it.

Fixes #904
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MrArnoldPalmer MrArnoldPalmer

Labels
feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(jsii-config): jsii-config MrArnoldPalmer/jsii
3 participants
@RomainMuller @eladb @MrArnoldPalmer