NativeScript / NativeScript/nativescript-cli
Feature Request: Use schematics for project transformations
还没有人认领这个 Issue。
- 主要语言
- JavaScript
- 星标
- 1.1k
- 派生
- 204
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 8
描述
What is Schematics?
Schematics is a workflow tool for project transformations, such as scaffolding, file updates and tasks execution (npm install, git init). It can apply rules* from predefined collections - for example generate a new Angular project using the @schematics/angular collection or set up Kendo UI using the @progress/kendo-schematics collection.
* rules - should also be called schematics, but that's confusing, so I'll stick to the name rules instead.
Who uses Schematics?
Schematics is extensively used inside the Angular CLI. It's the backbone of the commands:
- ng new - generates the files for a new Angular project, initializes a git repository and installs the node dependencies. It supports a large range of options, such as
routing- whether routing configuration should be generated,styling- what css preprocessor should be used,skipTests- whether test setup should be generated, etc. - ng generate - performs project transformations using a provided rule name and collection.
- ng add - installs a plugin and executes the setup logic provided by the plugin. For example -
ng add @nativescript/schematicsconverts the project to a code-sharing structure by adding all necessary NativeScript dependencies and the minimal setup for running a mobile app.
How can Schematics be used in the NativeScript CLI?
1. tns generate
Create a command that behaves similarly to ng generate. The @nativescript/schematics collection can be extended with non-Angular rules (Vue.js, plain NativeScript). This will allow all NativeScript developers to use schematics in their projects.
2. tns plugin add
There is already a tns plugin add command in NativeScript CLI, which installs NativeScript plugins and performs project modifications.
With schematics, the NativeScript CLI can:
- Perform the project modifications. The advantage over the current implementation is that with
Schematicsall changes are recorded in memory and are executed only after they're confirmed to be valid. In other words - if the command fails, no changes will be applied to the project. - Execute setup rules distributed by the plugins, similarly to
ng add. This will simplify the setup of plugins which currently rely on executingpostinstallscripts, such asnativescript-dev-webpackandnativescript-plugin-firebase.
It will also allow every NativeScript plugin to add a rule to automate the setup of the plugin. For example, thenativescript-pro-uiplugin will be able to provide a rule, which imports its NgModule in the root NgModule if the project uses Angular.
3. tns create
Schematics provides a powerful template engine. The NativeScript templates can be turned into schematic rules. The benefits:
- a lot of the common parts (such as
package.json) will be reused; - new project options will be trivial to add (
routing,style,sidedrawer,tabview, etc.); - the rules will be hosted in a monorepo instead of separated repos for each template.
Also, the NativeScript CLI will be able to perform tasks, similarly to the Angular CLI - it could initialize a git repository for the project, install the project dependencies, etc.
Please share your feedback in the comments!
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
审查现有的 tns generate、tns plugin add 和 tns create 命令实现,以及 NativeScript 模板和插件设置目前的工作方式。将其与所描述的 Schematics 工作流进行比较,并确定集成范围;完成意味着受影响的命令支持所提议的基于 schematic 的转换和任务执行。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- cli, mobile
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100