Allow to display custom Attributes in the Properties description #152

Claymore1337 · 2019-07-25T15:27:29Z

issue #151

In my project i have some attributes in the properties section which are not part of the JSONSchema. My requirment is to display also this properties.

So i would suggest to extend the the tool with an addtional parameter which except a list of
comma-separated values. This values will be used to read custom attributes of that propeties.

A new console arg was added. This arg except a comma separated list. This list will be used to read the custom attributes of an property re adobe#151

# Conflicts: # cli.js

ghost · 2019-07-26T07:42:17Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

trieloff

Looks good, but the whitespace settings in your git client seem off.

trieloff

Could you also include an example in README.md and an integration test?

Claymore1337 · 2019-07-26T08:17:00Z

I think you mean the line endigs? Normally I use the recomend windows setting "core.autocrlf true". But if i enable this option on this project the properties list did not build correctly

So I have disable the convert. But when I use npm run commit it seems that it still do the convert.

And yes I will add the option to the Readme.md file and I will write a short test for it

Claymore1337 · 2019-07-26T08:39:01Z

@trieloff
Should I include it to all schemas ?In this block

Or should it get there own run with a singel file?

trieloff · 2019-07-26T08:55:07Z

Add it to the block you've outlined. I think it's good to have one example with minimum options and one with all options and hope that we never get options with cross-dependencies.

Add description into README.md file and add the new property into the tests re adobe#151

ghost · 2019-07-26T12:37:50Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Bugfix re adobe#151

ghost · 2019-07-26T13:41:23Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Claymore1337 · 2019-07-26T13:44:47Z

@trieloff
I have added 2 fields to the schema example files and use this fields now in the test.

ghost · 2019-07-29T11:06:06Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Testfix after merging master re adobe#151

ghost · 2019-07-29T12:02:37Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

trieloff

We are getting there. I've found two typos and would suggest we declare p as an array property, which reduces the parsing burden.

README.md

trieloff · 2019-07-29T13:29:44Z

cli.js

+ }
+ })
+ .alias('p', 'properties')
+ .describe('p', 'A comma separated list with custom properties which should be also in the description of an element.')


Suggested change

.describe('p', 'A comma separated list with custom properties which should be also in the description of an element.')

.describe('p', 'A comma separated list with custom properties which should be also in the description of an element.')

.array('p')

This will use the built-in multi-value support in yargs, so that you can call jsonschema2md -p version -p test or jsonschema2md -p version test. I think that's more robust than trying to split the array yourself. (You'd have to adjust the rest)

@trieloff
As far as I see the parser which is used did not have the function array.

So your suggestion will result in an error

My bad, I forgot we are using optimist, not yargs.

Co-Authored-By: Lars Trieloff <lars@trieloff.net>

ghost · 2019-07-30T09:07:09Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Co-Authored-By: Lars Trieloff <lars@trieloff.net>

ghost · 2019-07-30T09:07:24Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

ghost · 2019-07-30T09:07:24Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

trieloff · 2019-07-30T09:41:36Z

I've merged your other PR, now there's some cleanup work to do, but then we should be ready. Again, sorry for the confusion regarding the command line arguments.

Allow the use to disable the header over console args re adobe#152

Merge branch 'parent-master' into costumProperties re adobe#151

ghost · 2019-08-15T09:31:59Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Claymore1337 · 2019-08-15T09:34:45Z

@trieloff
I merged the master into the branch. It should be now ready to be merged.

ghost · 2019-08-20T11:38:28Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

ghost · 2019-08-20T11:38:41Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

Claymore1337 · 2019-08-26T11:21:11Z

@trieloff
Hi I wanted to update the Branch with the lastest changes. There I have seen that the dependency ajv was removed. But it is still used in the cli.js. This result in the following lintig error

How should I proceed? Should I add ajv again?

trieloff · 2019-08-26T12:45:08Z

Yes, please re-add it.

Merge branch 'master' into costumProperties re adobe#151

ghost · 2019-08-26T13:53:49Z

There were the following issues with this Pull Request

Commit: 1a6beb1
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 95b2c97
- ✖ message may not be empty
- ✖ type may not be empty
Commit: 61abcf1
- ✖ message may not be empty
- ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!

trieloff · 2019-08-26T14:18:23Z

Thank you for your contribution and your perseverance in the process, @Claymore1337

trieloff · 2019-08-26T14:19:38Z

🎉 This PR is included in version 3.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Roman Kunz added 4 commits July 24, 2019 17:33

Feature: Added satic costum fields for properties

10455c6

feat: Allow custom attributes in properties

53690c9

A new console arg was added. This arg except a comma separated list. This list will be used to read the custom attributes of an property re adobe#151

Merge branch 'master' into costumProperties

c2ab084

# Conflicts: # cli.js

Syntax fix

1a6beb1

trieloff approved these changes Jul 26, 2019

View reviewed changes

trieloff requested changes Jul 26, 2019

View reviewed changes

feat: Allow custom attributes in properties

24592d0

Add description into README.md file and add the new property into the tests re adobe#151

feat: Allow custom attributes in properties

f616065

Bugfix re adobe#151

Merge branch 'master' into costumProperties

b18651e

feat: Allow custom attributes in properties

53073b4

Testfix after merging master re adobe#151

trieloff requested changes Jul 29, 2019

View reviewed changes

Update README.md

95b2c97

Co-Authored-By: Lars Trieloff <lars@trieloff.net>

Update README.md

61abcf1

Co-Authored-By: Lars Trieloff <lars@trieloff.net>

trieloff approved these changes Jul 30, 2019

View reviewed changes

Claymore1337 pushed a commit to Claymore1337/jsonschema2md that referenced this pull request Aug 15, 2019

feat: disable header

56d08c4

Allow the use to disable the header over console args re adobe#152

feat: allow custom properties in schema

419fa5d

Merge branch 'parent-master' into costumProperties re adobe#151

Merge branch 'master' into costumProperties

c129413

Merge branch 'master' into costumProperties

64078e2

COMLINE\Kunz added 2 commits August 26, 2019 15:52

feat: merge branch 'master' into costumProperties

36d75ea

Merge branch 'master' into costumProperties re adobe#151

Merge branch 'parent-master' into costumProperties

bf38ba1

trieloff merged commit 0634309 into adobe:master Aug 26, 2019

trieloff added the released label Aug 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to display custom Attributes in the Properties description #152

Allow to display custom Attributes in the Properties description #152

Claymore1337 commented Jul 25, 2019

ghost commented Jul 26, 2019

trieloff left a comment

trieloff left a comment

Claymore1337 commented Jul 26, 2019

Claymore1337 commented Jul 26, 2019

trieloff commented Jul 26, 2019

ghost commented Jul 26, 2019

ghost commented Jul 26, 2019

Claymore1337 commented Jul 26, 2019

ghost commented Jul 29, 2019

ghost commented Jul 29, 2019

trieloff left a comment

trieloff Jul 29, 2019

Claymore1337 Jul 30, 2019

trieloff Jul 30, 2019

ghost commented Jul 30, 2019

ghost commented Jul 30, 2019

ghost commented Jul 30, 2019

trieloff commented Jul 30, 2019

ghost commented Aug 15, 2019

Claymore1337 commented Aug 15, 2019

ghost commented Aug 20, 2019

ghost commented Aug 20, 2019

Claymore1337 commented Aug 26, 2019

trieloff commented Aug 26, 2019

ghost commented Aug 26, 2019

trieloff commented Aug 26, 2019

trieloff commented Aug 26, 2019

	.describe('p', 'A comma separated list with custom properties which should be also in the description of an element.')
	.describe('p', 'A comma separated list with custom properties which should be also in the description of an element.')
	.array('p')

Allow to display custom Attributes in the Properties description #152

Allow to display custom Attributes in the Properties description #152

Conversation

Claymore1337 commented Jul 25, 2019

ghost commented Jul 26, 2019

trieloff left a comment

Choose a reason for hiding this comment

trieloff left a comment

Choose a reason for hiding this comment

Claymore1337 commented Jul 26, 2019

Claymore1337 commented Jul 26, 2019

trieloff commented Jul 26, 2019

ghost commented Jul 26, 2019

ghost commented Jul 26, 2019

Claymore1337 commented Jul 26, 2019

ghost commented Jul 29, 2019

ghost commented Jul 29, 2019

trieloff left a comment

Choose a reason for hiding this comment

trieloff Jul 29, 2019

Choose a reason for hiding this comment

Claymore1337 Jul 30, 2019

Choose a reason for hiding this comment

trieloff Jul 30, 2019

Choose a reason for hiding this comment

ghost commented Jul 30, 2019

ghost commented Jul 30, 2019

ghost commented Jul 30, 2019

trieloff commented Jul 30, 2019

ghost commented Aug 15, 2019

Claymore1337 commented Aug 15, 2019

ghost commented Aug 20, 2019

ghost commented Aug 20, 2019

Claymore1337 commented Aug 26, 2019

trieloff commented Aug 26, 2019

ghost commented Aug 26, 2019

trieloff commented Aug 26, 2019

trieloff commented Aug 26, 2019