NativeScript / NativeScript/nativescript-cli

Feature Request: Use schematics for project transformations

Ouverte
#3,860 2 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature
Langage dominant
JavaScript
Étoiles
1.1k
Forks
204
Merge moyen
1 j 9 h
PR mergées (30 j)
8

Description

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/schematics converts 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 Schematics all 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 executing postinstall scripts, such as nativescript-dev-webpack and nativescript-plugin-firebase.
    It will also allow every NativeScript plugin to add a rule to automate the setup of the plugin. For example, the nativescript-pro-ui plugin 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!

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez les implémentations existantes des commandes tns generate, tns plugin add et tns create, ainsi que le fonctionnement actuel des templates NativeScript et de la configuration des plugins. Comparez-les aux workflows Schematics décrits et définissez le périmètre de l’intégration ; le travail est considéré comme terminé lorsque les commandes concernées prennent en charge les transformations proposées basées sur des schematics et l’exécution des tâches.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
cli, mobile
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.