Skip to content

docs(cli): use a custom repository base class #2317

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

Merged
bajtos merged 3 commits into from Feb 4, 2019
Merged

docs(cli): use a custom repository base class #2317

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
152007f
docs(cli): use a custom repository base class
Jan 31, 2019
3f86fa0
Merge branch 'master' into patch-1
Feb 3, 2019
367a51d
docs(cli): use a custom repository base class
Feb 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/site/Repository-generator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ src/datasources
model. If you supply this value, the CLI will not try to infer this value from
the selected model file.

`--repositoryBaseClass` : _(Optional)_ _(Default: DefaultCrudRepository)_ name
of the base class the repository will inherit. If no value was supplied,
**DefaultCrudRepository** will be used.

### Configuration file

This generator supports a config file with the following format, see the
Expand All @@ -40,7 +44,8 @@ file.
"name": "repositoryNameToBeGenerated",
"datasource": "validDataSourceName",
"model": "validDModelName",
"id": "anOptionalNameForID"
"id": "anOptionalNameForID",
"repositoryBaseClass": "validRepositoryBaseClass"
}
```

Expand Down Expand Up @@ -82,6 +87,14 @@ The tool will prompt you for:
**NOTE:** The tool will inspect each of the selected models and try to find
the name of the property serving as **ID** for the model.

- **Please select the repository base class.** _(repository)_ if the name of a
valid base class has been supplied from the command line, the prompt is
skipped, otherwise it will present you a list of repositories. The default
repository is infered from the datasource type.

Any repository in the `src/repository` folder with the file format
`*.repository.base.ts` will be added to the list too.

- **Please enter the name of the ID property for _modelName_.** _(id)_ If the
CLI cannot find the corresponding ID property name for the model, it will
prompt you to enter a name here. If you don't specify any name, it will use
Expand Down