Structure de répertoire pour le fichier d'enregistrement des projets

Ce qui serait une idiomatiques structure de répertoire pour un Tapuscrit projet?

Je voudrais les fonctionnalités suivantes dans une telle structure:

  1. Des répertoires distincts pour Tapuscrit code source et transpiled JavaScript
  2. Des répertoires distincts pour projet de code source et de code de test
  3. Mécanisme pour résoudre les références à travers des tests et le code source.
si vous souhaitez des exemples sur la façon de structurer vos projets, il y en a beaucoup sur internet. C'est principalement opinion fondée et pas quelque chose de stackoverflow peut vous aider avec. 🙂

OriginalL'auteur codematix | 2016-03-04

  1. 9

    Séparant JS généré à partir de la source TS

    Je recommande de générer un seul fichier de sortie. Être un navigateur ou pour le Nœud, c'est juste une meilleure idée. Gardez à l'esprit que la plupart des IDEs pouvez masquer .gitignored fichiers, donc une zone d'un fichier-volet ne devrait pas être un problème à atteindre, même si vous laissez le .js fichiers assis juste à côté de leur .ts fichiers.

    Vous peut utiliser techniquement --outDir à la sortie de la façon dont vous le souhaitez par la mise en place de votre tsconfig.json de façon appropriée.

    La séparation des tests à partir de la source

    C'est assez trivial! Simplement de maintenir un /tests. Les importations de travail simplement par traversée de répertoires comme import {MyClass} from "../src/modules/my-class" (où le ../ est de sortir de /tests).

    Mécanisme pour résoudre les références

    C'est plus difficile dans le navigateur que sur le Nœud, ce dernier en a requires de travail hors de la boîte pour Tapuscrit.

    Sur le navigateur

    Recommandons fortement d'aller avec quelque chose comme webpack, mais si vous insistez sur la vie de la vie sur l'secondaires dangereux, ici, est un navigateur convivial nécessitent l'utilisation de rapidement effectuer une itération sur Tapuscrit du code sans avoir un processus de construction de l'installation.

    require() pour le navigateur

    • Pas pour les faibles de cœur — c'est tech de la dette, vous accumulerez

    Depuis des chemins absolus sont nécessaires pour travailler en web importations, voici comment vous pouvez utiliser mon require() hack avec Tapuscrit (typiquement, pour une rapide session de débogage qui ne nécessite pas de reconstruction).

    /entities/user.ts

    import {Username} from "../entities/username";
import {Password} from "../entities/password";

export class User {
    username: Username;
    password: Password;
}

    Où Username et Password sont exported classes dans /entities/username.ts et /entities/password.ts respectivement.

    Tandis que le ../entities/ peut sembler superflu, avis qu'il est essentiel pour le navigateur de chemins absolus pour notre Username et Password entités. 🙂

    Merci pour vos contributions. Votre post m'a conduit à trouver une solution.

    OriginalL'auteur Angad

  2. 5

    Regarde comme je le faisais mal. J'ai essayé la structure suivante: 

    src
|---- lib
|----- | ---- mymodule.ts
|---- tests
|----- | ---- mymodule.tests.ts

    Cependant, j'ai été de tenter de compiler le code source sous lib répertoire séparément du code de test sous tests.

    find src/lib -name *.ts | xargs tsc --declaration --sourceMap --module commonjs --target es5 --listFiles --outDir lib

    et puis les tests de code:

    find src/tests -name *.ts | xargs tsc --declaration --sourceMap --module commonjs --target es5 --listFiles --outDir tests

    De ce fait, les tests dossier pour avoir un autre lib sous-répertoire et un tests sous-répertoire. Ce n'était pas ce que je désirais avoir.

    Pour résoudre mon problème, j'ai besoin de compiler leur ensemble, donc maintenant, ma commande est:

    find src -name *.ts | xargs tsc --declaration --sourceMap --module commonjs --target es5 --listFiles --outDir .

    Merci à tous pour l'aide.

    Merci. Maintenant, j'ai structuré mon projet de la même façon avec un tsconfig.json placé dans le dossier src et je viens de lancer "tsc -p ./src" pour obtenir tout ce à compiler.
    Juste un heads-up, il est assez simple pour automatiser la création de tsconfig.json à l'aide de le droit outils, tels que Atom TypeScript sur l'Atome. Vous recommandons fortement de vérifier si vous n'avez pas déjà choisi un répertoire particulier de la structure en raison de processus de construction sonne comme le début d'une lisibilité de la dette 🙂

    OriginalL'auteur codematix

  3. 3

    Il est très difficile de donner des conseils, car cette immense dépend de la taille du projet, des outils, plate-forme, etc.

    1. Tapuscrit compilateur a une outDir option que vous pouvez utiliser pour la sortie de répertoire distinct. Toutefois, vous aussi, vous avez probablement comme pour bundle donc sortie un seul fichier peut être préférable, aussi longtemps que vous créez carte fichiers à des fins de débogage. Vous pouvez structurer tout cela très bien avec Gulp par exemple.
    2. Ce que cela a à voir avec la structure de répertoire? Si vous voulez diviser, diviser ensuite
    3. "Mécanisme" est très large et dépend des outils que vous utilisez. Par exemple, le lanceur de test pourrait être en mesure de "l'importation" de la production de code avant le code de test. Vous pouvez utiliser certaines module de chargement de la bibliothèque ainsi etc etc.
    Merci pour vos contributions!

    OriginalL'auteur Denis Biondic