Skip to content

Custom modifiers is not worksΒ #173

@gialloguitar

Description

@gialloguitar

Hi!
Im trying to follow README to declare a new types of modifiers like this:

...
  "modifiers": {
    "array": "array",
    "object": "object",
    "string": "string",
    "nullable": "nullable",
    "default": "default",
    "boolean": "boolean",
    "number": "number",
    "integer": "integer"
  },
...

My test chart values is:

## @param enabled [boolean, nullable] Desc
enabled: false

Run:
readme-generator-for-helm -c config.json -r tmp/README.md -v tmp/values.yaml -s tmp/values.schema.json

and I've got an error:

INFO: Checking missing metadata...
INFO: Metadata is correct!
/snapshot/helm-readme-generator/lib/builder.js:53
        throw new Error(`Unknown modifier: ${modifier} for parameter ${param.name}`);
        ^

Error: Unknown modifier: boolean for parameter enabled
    at /snapshot/helm-readme-generator/lib/builder.js:53:15
    at Array.forEach (<anonymous>)
    at applyModifiers (/snapshot/helm-readme-generator/lib/builder.js:22:19)
    at buildParamsToRenderList (/snapshot/helm-readme-generator/lib/builder.js:109:7)
    at /snapshot/helm-readme-generator/index.js:53:30
    at Array.forEach (<anonymous>)
    at runReadmeGenerator (/snapshot/helm-readme-generator/index.js:52:31)
    at Object.<anonymous> (/snapshot/helm-readme-generator/bin/index.js:22:1)
    at Module._compile (pkg/prelude/bootstrap.js:1926:22)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1159:10)

NOTE: If use values like this:

...
## @param enabled Desc
enabled: false

,then the boolean type will be success detected in JSON schema. But I need to work with nullable values, but custom modifires not works as expected.

My version of package is 2.7.2

Btw, looks like custom modifiers doesn't support here, but I can mistake.

Thank you!

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions