loopbackio / loopbackio/loopback-next
Clean up datasource template
オープン
@mrmodise がすでに取り組んでいます。
2021年2月21日 から。
good first issue
Hacktoberfest
tech-debt
- 主要言語
- TypeScript
- スター
- 5.1k
- フォーク
- 1.1k
- 平均マージ
- 2日 21時間
- マージ済み PR(30日)
- 27
説明
This is a follow-up issue for #5000 where we moved datasource config from JSON files to TS files and discovered few aspects of the datasource template that can be improved.
- Update https://github.com/strongloop/loopback4-example-shopping to follow the new style
- Update https://github.com/strongloop/loopback-next/blob/master/docs/site/Inside-Loopback-Application.md to follow the new style
- Make the static DataSource property
nameread-only, set it fromconfig.nameto avoid duplication. - Rework datasources to receive the configuration via
@config, so that they can be configured viaapp.configure(). Update the docs (especially Cloudant & Bluemix guides), make sure to preserve content for the old configuration style (think of existing projects created before the change). - Fix datasource files in
examplesto use the same style as scaffolded bylb4 datasource. Most notably, change them to participate in app life-cycle and disconnect when the application has stopped. Update the docs accordingly. - Verify that integration tests instantiating datasource classes directly are stopping them after the tests are over + update the relevant docs (e.g. testing best practices).
- Remove start/stop code in favor of
stop()method provided directly by juggler, see https://github.com/strongloop/loopback-datasource-juggler/pull/1835 and #5279
Acceptance criteria
For each of the items above, consider the following places to update
- The template in packages/cli/generators/datasource/templates/datasource.ts.ejs
- The template used by CLI tests - see getSourceForDataSourceClassWithConfig()
- All documentation pages in
docs/site, do a text search to find all snippets showing a datasource - All example applications in
examples
🎆 Hacktoberfest 2020
Greetings 👋 to all Hacktoberfest 2020 participants!
Here are few tips 👀 to make your start easier, see also #6456:
- Before you start working on this issue, please leave a comment to let others know.
- This issue consists of several tasks to work on, it may feel like a too big effort to undertake. Don't worry! It's perfectly fine to pick just one item from the list and leave the rest for somebody else. In fact, we prefer to have a dedicated pull request for each part, to make it easier for us to review the changes and get the pull request landed faster. Baby steps FTW! Remember, every little helps.
- If you are new to GitHub pull requests, then you can learn about the process in Submitting a pull request to LoopBack 4.
- If this is your first contribution to LoopBack, then please take a look at our Developer guide
- Feel free to ask for help in
#loopback-contributorschannel, you can join our Slack workspace here.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
評価
この issue はまだ評価されていません。