hornet-js-builder-new v2.0.0-RC1
hornet-js-builder
hornet-js-builder
a été développé dans le but premier de masquer la complexité des différentes tâches nécessaires à la construction d'un projet. Son second objectif est d'accompagner le développeur en lui fournissant des outils tout au long du developpement d'un projet.
A cet effet, il surcharge les librairies gulp
et npm
pour fournir des tâches se rapprochant de la philosophie maven
ainsi que des utilitaires pour simplifier et pérenniser la gestion des dépendances.
Les versions de chaque dépendance déclarée doivent également être fixes (sans ^, ~ ou *) afin de pérenniser les versions.
Installation
Depuis NPM
npm install -g hornet-js-builder
s'assurer que les liens symboliques hornetbuilder
et hb
ont bien été crées dans le répertoire "~/bin". Si ce n'est pas le cas:
se positionner dans le répertoire "~/bin", puis:
ln -s ${cheminAccesHornetBuilderInstalléDansNode}/bin/builder-cli.js hb
ln -s ${cheminAccesHornetBuilderInstalléDansNode}/bin/builder-cli.js hornetbuilder
Depuis les sources
Installer hornet-js-builder
de manière globale:
- Se placer dans le dossier de hornet-js-builder
- Lancer la commande
npm install -g
Note
En cas de MAJ à partir d'une version antérieure de hornet-js-builder
: supprimer les dossiers node_modules
de chaque projet
Commandes
Suite à cette installation, les commandes hornetbuilder
et hb
(alias de la première) sont accessibles en globale dans les scripts
Principe de gestion des dépendances
Un projet géré par le builder est un projet node classique avec une déclaration des dépendances dans le fichier package.json.
dependencies
: Pour déclarer les dépendances applicativesdevDependencies
: Pour déclarer les dépendances de build (les dépendances nécessaires uniquement pour les TU, la documentation des modules utilisés, les modules nécessaires lors du package etc.)peerdependencies
: Pour déclarer les dépendences du host qui sont nécessaires à l'installation du modulebundleddependencies
: Pour déclarer un tableau de dépendances qui seront packagés lors de la publication du moduleoptionaldependencies
: Pour déclarer les dépendances optionnelles c'est-à-dire celles dont une erreur d'install ne causera pas de build failure.
Utiliser hornetbuilder en ligne de commandes
- Ouvrir une invite de commande et se placer dans le dossier du projet.
Exemple:
cd D:\dev\workspace\applitutoriel\applitutoriel-js
- Taper la commande
hornetbuilder
(ouhb
) suivi de la tâche à exécuter. Exemple:
hb test
Une aide est fournie en tapant la commande
hb --help
Les options suivantes sont alors proposées:
Option | Rôle |
---|---|
-V, --version | Affiche la version du builder |
-d, --debug | Active les messages de logs du builder en mode debug |
--show-webpack-files | Active le listing des fichiers embarqués par webpack lors de la construction du bundle de fichiers clients. Note: Les fichiers sont triés par taille croissante |
--webpackVisualizer | Visualisation de la répartition des sources projets et node modules dans un chart, /static/dev/webpack-visualizer.html |
-i, --ide | Indique que c'est l'IDE qui gère la compilation des fichiers .ts, .d.ts et .map. Dans ce mode la compilation des fichiers TypeScripts est désactivée ainsi que les watchers associés. De même, la tâche clean ne supprime plus ces fichiers. Cette option doit être utilisée dès lors qu'un IDE est lancé sur les projets |
-r, --registry | Permet d'utiliser un repository spécifique. Par défaut le repository défini dans le fichier .npmrc est utilisé |
--publish-registry | Permet de spécifier un repository npm spécifique pour la publication autre que celui par défaut. Par défaut le repository défini dans le fichier .npmrc est utilisé |
-f, --force | Permet de forcer la mise à jour des dépendances |
--skipTests | Permet de ne pas exécuter les tests si ceux-ci doivent être exécutés (ex: tâche package ) |
--skipDedupe | Permet de ne pas exécuter npm dedupe sur l'installation des dépendances |
--stopOnError | Permet de stopper toutes les tâches sur une erreur dans les tests |
--skipMinified | Permet de ne pas minifier les chuncks |
--noWarn | Permet de ne pas afficher les warning |
-p, --debugPort | Indique le port utilisé par node pour permettre la connexion d'un debugger externe" |
--lintRules | Indique un fichier de rules tslint.json autre que celui utilisé par le builder |
--lintReport | Indique le format de sortie pour tslint : prose (défaut), json , verbose , full , msbuild |
--file | Indique le chemin d'un fichier |
--dev | active le mode developpement |
--offline | active le mode offline pour la récupération des dépendances, ex : coupure réseau. Prerequis avoir les node_modules, ajouter fetch-retries=0 dans .npmrc |
--versionFix | Indique la version ou suffixe si commence par '-', '.' ou si null calcule un suffixe avec timestamp, si 'RC' calucle la prochaine RC. |
--versionSearch | préfixe de la dernière version" |
Utiliser hornetbuilder en mode interactive
Le principe du mode interactive est d'être immergé dans les commandes du builder sans pour autant à avoir à retaper "hb ..." et de bénéficier d'un mode intuitif d'autocompletion.
hb
Résultat :
[15:49:52]
_ _ _ _
| | | | | | (_)
| |__| | ___ _ __ _ __ ___| |_ _ ___
| __ |/ _ \| '__| '_ \ / _ \ __| | / __|
| | | | (_) | | | | | | __/ |_ _ | \_ \
|_| |_|\___/|_| |_| |_|\___|\__|(_)| |___/
_/ |
|__/
[15:49:52] Démarrage de hornet-js-builder dans /home/<user>/Dev/workspaceJS/applitutoriel-modules/applitutoriel-js
[ '/home/<user>/Dev/node-v8.14.0-linux-x64/bin/node',
'/home/<user>/bin/hbn' ]
[16:01:33] Builder lancé sur le projet applitutoriel-js en version 5.4.0
[16:01:33] Utilisation du registry configuré dans NPM : http://artifactory.app.diplomatie.gouv.fr/artifactory-dev/api/npm/repository-npm-mae-dev
[16:01:35] Chargement des tâches du projet 'applitutoriel-js'
[16:01:35] __la task rewrite est terminée
[16:01:35] _Starting 'dependencies:install-dev'...
[16:01:35] Lancement installation des dépendances de applitutoriel-js
[16:01:37] _Finished 'dependencies:install-dev' after 2.67 s
[16:01:37] _Starting 'default'...
[16:01:37] __Starting 'interactive'...
hb$
le prompt "hb$" s'affiche est permet alors de lancer n'importe quelle commande du builder.
Il est possible de lister toutes les commandes avec un double "tab" ou bien d'utiliser l'aide
hb$ help
L'arrêt du mode interactive ce fait avec la commande "exit".
hb$ exit
Configurer un projet pour utiliser hornetbuilder
Fichier de configuration des dépendances : package.json
Exemple complet de package.json
{
"name": "applitutoriel-js-lite",
"version": "5.x.x",
"license": "CECILL-2.1",
"main": "index.js",
"description": "Application tutoriel utilisant le Framework hornet",
"bugs": {
"url": "https://github.com/diplomatiegouvfr/applitutoriel-modules/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/diplomatiegouvfr/applitutoriel-modules.git"
},
"dependencies": {
"applitutoriel-js-common": "5.x.x",
"hornet-js-core": "5.x.x",
"hornet-js-database": "5.x.x",
"hornet-js-passport": "5.x.x",
"hornet-js-react-components": "5.x.x",
"hornet-js-logger": "5.x.x",
"hornet-themes-intranet": "5.x.x",
"hornet-js-utils": "5.x.x",
"hornet-js-bean": "5.x.x",
"pg": "~7.3.0",
"sequelize": "~4.33.4",
"sqlite3": "~3.1.13",
"tslib": "~1.9.3"
},
"devDependencies": {
"@types/node": "~10.12.30",
"@types/react": "~16.8.14",
"@types/sequelize": "~4.27.48",
"hornet-js-test": "5.x.x"
},
"scripts": {
"init-dev": "hb install",
"start": "node index.js"
},
"author": "MEAE - Ministère de l'Europe et des Affaires étrangères"
}
Fichier de configuration Typescript pour la compilation : tsconfig.json
Les projets doivent impérativement avoir un fichier tsconfig.json
à la racine.
Celui-ci regroupe les informations de compilation typescript nécessaire au projet.
ex :
{
"compilerOptions": {
"baseUrl": "./",
"emitDecoratorMetadata": true,
"esModuleInterop": false,
"experimentalDecorators": true,
"importHelpers": true,
"jsx": "react",
"lib": ["dom", "es2015"],
"module": "commonjs",
"moduleResolution": "node",
"resolveJsonModule": true,
"skipLibCheck": true,
"sourceMap": true,
"target": "ES5",
"preserveSymlinks": true
},
"include": [
"index.ts",
"src/**/*.ts*",
"test/**/*.ts*",
"./node_modules/applitutoriel-js-common/index.d.ts",
"./node_modules/hornet-js-bean/index.d.ts",
"./node_modules/hornet-js-components/index.d.ts",
"./node_modules/hornet-js-core/index.d.ts",
"./node_modules/hornet-js-database/index.d.ts",
"./node_modules/hornet-js-logger/index.d.ts",
"./node_modules/hornet-js-utils/index.d.ts",
"./node_modules/hornet-js-passport/index.d.ts",
"./node_modules/hornet-js-react-components/index.d.ts",
"./node_modules/hornet-js-test/index.d.ts"
],
"exclude": [
"istanbul"
]
}
Fichier de configuration builder : builder.js
Les projets doivent comporter à la racine un fichier builder.js
afin de déterminer le type de l'application : application
, module
, ... ainsi que les différentes tâches à éxécuter nécessaire à la construction.
Ce fichier doit comporter au minimum le code suivant pour hornet.js:
module.exports = {
type: "application",
authorizedPrerelease: "true",
gulpTasks: function (gulp, project, conf, helper) {
//Add task if needed
/*gulp.beforeTask("compile", function () {
helper.info("Exemple before compile task");
});
gulp.afterTask("compile", function () {
helper.info("Exemple after compile task");
});*/
// Cas PARTICULIER de l'application tuto pour pouvoir la générer en mode SPA et ISOMORPHIC sur la PIC
// => on force la tâche prepare-package:spa tout le temps
// si mode fullSpa : on redéfini les tâches 'watch' & 'watch-prod' pour y inclure la tâche "prepare-package-spa"
//gulp.task("watch", ["compile", "prepare-package:spa", "watch:client"]);
//gulp.task("watch-prod", ["compile", "prepare-package:spa", "watch:client-prod"]);
gulp.addTaskDependency("package-zip-static", "prepare-package:spa");
// conf.template.messages = require("applitutoriel-js-common/src/resources/messages.json")
conf.template.forEach((elt, idx) => {
if (conf.template[idx].context.forEach) {
conf.template[idx].context.forEach((elt, idx2) => {
conf.template[idx].context[idx2].messages = {"applicationTitle": "Application TUTORIEL"};
});
} else {
conf.template[idx].context.messages = {"applicationTitle": "Application TUTORIEL"};
}
});
},
externalModules: {
enabled: false,
directories: [
]
},
config: {
routesDirs: ["." + path.sep + "routes"],
// Exemple d'exclusion de fichiers/répertoires local à l'application et de modules
// Cet exemple n'est pas forcement cohérent puisque le client.js n'est pas dépendant des middlewares
// Il est là à titre d'exemple uniquement
clientExclude: {
dirs: [
path.join("src", "services", "data"),
"src/middleware",
"nodemailer",
"applitutoriel-js-common/src/actions"],
filters: [
path.join("src", "services", "data") + "/.*-data-\.*",
".*/src/actions/.*",
"^config/*"
],
modules: [
"config",
"continuation-local-storage",
"carbone",
"pdfmake",
"pdfmake/src/printer",
"pdfkit",
"nodemailer",
"fontkit"
]
},
clientContext: [
[/moment[\/\\]locale$/, /fr|en/],
[/intl[\/\\]locale-data[\/\\]jsonp$/, /fr|en/],
[/.appender/, /console/]
],
typescript: { //bin: "~/Dev/node-v4.5.0-linux-x64/lib/node_modules/typescript"
},
template: [
{
context: [{
error: "404",
suffixe: "_404",
message: "Oops! Nous ne trouvons pas ce que vous cherchez!"
}, {error: "500", suffixe: "_500", message: "Oops! Une erreur est survenue!"}],
dir: "./template/error",
dest: "/error"
}, {
context: {message: "test template"}
}
],
spaResources: [path.join("..", "applitutoriel-js-common", "src", "resources") + "**/*.json"],
dev: {
dllEntry: {vendor: ["ajv", "react-dom", "react", "bluebird", "moment", "intl", "moment-timezone", "lodash"]}
}
}
};
Ce fichier doit comporter au minimum le code suivant pour hornet.js-lite:
module.exports = {
type: "application",
gulpTasks: function (gulp, project, conf, helper) {
helper.excludeNodeModulesFromWebpack(
["config", "continuation-local-storage", "sequelize", "pdfmake", "carbone", "csv-parser", "nodemailer"],
conf.webPackConfiguration
);
conf.template.forEach((elt, idx) => {
if (conf.template[idx].context.forEach) {
conf.template[idx].context.forEach((elt, idx2) => {
conf.template[idx].context[idx2].messages = {"applicationTitle": "Application TUTORIEL"};
});
} else {
conf.template[idx].context.messages = {"applicationTitle": "Application TUTORIEL"};
}
});
},
externalModules: {
enabled: false,
directories: [
]
},
config: {
routesDirs: ["." + path.sep + "routes"],
ressources: ["database/**/*"],
// Exemple d'exclusion de fichiers/répertoires local à l'application et de modules
// Cet exemple n'est pas forcement cohérent puisque le client.js n'est pas dépendant des middlewares
// Il est là à titre d'exemple uniquement
clientExclude: {
dirs: [
path.join("src", "services", "data"),
path.join("src", "dao"),
"src/middleware",
"nodemailer"],
filters: [
path.join("src", "services", "data") + "/.*-data-\.*"
],
modules: [
"hornet-js-database",
"config",
"continuation-local-storage",
"sequelize",
"pdfmake",
"carbone",
"csv-parser",
"nodemailer",
"tls"
]
},
clientContext: [
[/moment[\/\\]locale$/, /fr|en/],
[/intl[\/\\]locale-data[\/\\]jsonp$/, /fr|en/],
[/.appender/, /console/]
],
typescript: { //bin: "~/Dev/node-v4.5.0-linux-x64/lib/node_modules/typescript"
},
karma: {
template: {
debug: "./test/template/debug.html",
context: "./test/template/context.html",
clientContext: "./test/template/client_with_context.html"
}
},
template: [
{
context: [{error: "404", suffixe: "_404", message: "Oops! Nous ne trouvons pas ce que vous cherchez!"}, {error: "500", suffixe: "_500", message: "Oops! Une erreur est survenue!"}],
dir: "./template/error",
dest: "/error"
}, {
context: {message: "test template"}
}
]
dev: {
dllEntry: {vendor: ["hornet-js-react-components", "hornet-js-components", "hornet-js-utils"]}//"ajv", "d3", "react-dom", "react", "bluebird", "moment", "intl", "moment-timezone", "lodash"
}
}
};
- La clé
type
indique au builder le type de projet actuel. Pour une application le type doit toujours êtreapplication
(types possibles : "parent", "application", "application-server", "module", "theme", "custom"). - La fonction
gulpTasks
permet :- d'ajouter de nouvelles tâches gulp au moyen du paramètre
gulp
- de modifier la configuration par défaut du builder (ajouter un répertoire de sources, modifier la conf webpack, ...)
- d'exécuter des traitements avant ou après une tâche spécifique au moyen des méthodes
gulp.beforeTask(taskName, func)
etgulp.afterTask(taskName, func)
- d'ajouter des dépendances à une tâche existante au moyen de la méthode
gulp.addTaskDependency(taskName, dependencyTaskName)
- d'ajouter de nouvelles tâches gulp au moyen du paramètre
- L'objet
externalModules
permet de déclarer des dépendances à partir de répertoires externes - L'objet
config
permet de surcharger la configuration du builder dans chaque applicationautoGenerateIndex
permet d'autogénérer lesindex.js
,index.ts
(utile pour le mode dev et dll, ou l'import auto des dts).index.d.ts
est autogénéré pour les types modules.routesDirs
permet de spécifier les répertoires des routes pour le code splitting automatiqueclientExclude
est un raccourci pour modifier la conf webpack et rajouter des externalsclientNoParse
est un raccourci pour modifier la conf webpack et rajouter des module.noParsetypescript.bin
permet de préciser une autre version de typescript pour la transpilation que celle utiliser ambarquée par le builderspaResources
liste de filtres permettant d'ajouter des ressources pour la génération de chunck SPAdllEntry
permet de préciser des dll webpack (gain de temps de construction des chunck)template
permet de configurer la tâche de templating htmldir
répertoire des templates (par défault 'template')context
objet disponible pour le templatingdest
répertoire de destination
clientContext
Filtre les modules ex moment et intl : [/moment\/\locale$/, /fr|en/], [intl\/\locale-data\/\jsonp$/, /fr|en/]spaFilter
Filtre les ressources pour le packaging spa, copie des fichiers ressource dans /staticdev
Expérimentation du builderdllEntry
optimisation de chargement des librairies en dev
context
contiendra par défaut :
{
project:
{
name: project.name,
version: project.version,
static: "static-" + project.version + "/"
}
}
Exemple:
...
gulpTasks: function (gulp, project, conf, helper) {
gulp.task("maNouvelleTache", function(done) {
helper.info("Execution de 'maNouvelleTache'");
done();
});
},
...
hb maNouvelleTache
Objet de configuration du builder
La configuration par défaut du builder est la suivante:
src: "src",
test: "test",
static: staticDir,
database: "database",
environment: {
dir: "environment",
configuration: "environment/configuration",
templates: "environment/templates"
},
testEnvironment: {
dir: "test-environment",
configuration: "test-environment/configuration",
templates: "test-environment/templates"
},
js: "js",
dll: "dll",
config: "./config",
generatedTypings: {
dir: ".",
file: "definition.d.ts"
},
clientJs: "client.js",
routesDirs: ["." + path.sep + "routes"],
componentsDirs: [path.join("..", "src")],
buildWorkDir: "target",
testReportDir: testReportDir,
testWorkDir: testWorkDir,
templateDir: "html",
sassConfiguration: {
sass: {
merge: true,
inputFilter: "./src/**/*.scss",
options: {
outputStyle: process.env.NODE_ENV !== "production" ? "expanded": "compressed",
data: ""
},
output: {
dir: path.join(staticDir, "css"),
fileName: process.env.NODE_ENV !== "production" ? "appli.css": "appli.min.css"
}
},
img: {
inputFilter: "./img/**/*.+(jpeg|jpg|png|gif|svg|ttf)",
output: {
dir: path.join(staticDir, "img")
},
template: path.join(__dirname, "..", "builders", "tasks", "sass", "sass-image-template.mustache")
}
},
mocha: {
reporter: "mocha-multi-reporters",
reporterOptions: {
"reporterEnabled": "spec, xunit, mocha-sonarqube-file-name-reporter",//'../mocha/mocha-sonarqube-file-name-reporter'
"specReporterOptions": {
output: path.join(testReportDir, "mocha", "spec-results.xml"),
},
"xunitReporterOptions": {
output: path.join(testReportDir, "mocha", "xunit-results.xml"),
},
"mochaSonarqubeFileNameReporterReporterOptions": {
output: path.join(testReportDir, "mocha", "test-results.xml"),
filenameFormatter: (currentPath) => {
let newFilePAth = path.join(process.cwd(), currentPath).replace("istanbul" + path.sep, "");
let exts = ["tsx", "ts", "js"];
if (path.extname(newFilePAth) == ".js") {
let originalFile = path.parse(newFilePAth);
originalFile.base = undefined;
let extIdx = 0;
do {
originalFile.ext = "." + exts[extIdx++];
} while (!fs.existsSync(path.format(originalFile)) && extIdx < exts.length);
return path.format(originalFile).replace(process.cwd() + path.sep, '');
}
}
},
}
//,"grep": "Router constructor"
},
istanbul: {
dir: path.join(testWorkDir),
reporters: ["lcov", "text", "text-summary", "cobertura", "json", "html"],
reportOpts: {
dir: path.join(testReportDir, "mocha"),
lcov: { dir: path.join(testReportDir, "mocha", "lcov"), file: "lcov.info" },
html: { dir: path.join(testReportDir, "mocha", "html") },
json: { dir: path.join(testReportDir, "mocha"), file: "coverage_mocha.json" },
cobertura: { dir: path.join(testReportDir, "mocha") }
}
},
karma: {
reporters: ["mocha", "coverage"],
reportOpts: {
dir: path.join(testReportDir, "karma"),
lcov: { dir: path.join(testReportDir, "karma", "lcov"), file: "lcov.info" },
html: { dir: path.join(testReportDir, "karma", "html") },
json: { dir: path.join(testReportDir, "karma"), file: "converage_karma.json" }
}
}, merge: {
reporters: ["lcov", "text", "text-summary", "cobertura", "json", "html"],
reportOpts: {
dir: path.join(testReportDir, "merge"),
lcov: { dir: path.join(testReportDir, "merge", "lcov"), file: "lcov.info" },
html: { dir: path.join(testReportDir, "merge", "html") },
json: { dir: path.join(testReportDir, "merge"), file: "coverage.json" },
cobertura: { dir: path.join(testReportDir, "merge") }
}
}, remap: {
reporters: ["lcovonly", "text", "text-summary", "cobertura", "json", "html"],
reportOpts: {
dir: path.join(testReportDir, "remap"),
lcovonly: { dir: path.join(testReportDir, "remap", "lcov"), file: "lcov.info" },
html: { dir: path.join(testReportDir, "remap", "html") },
json: { dir: path.join(testReportDir, "remap"), file: "coverage.json" },
cobertura: { dir: path.join(testReportDir, "remap"), file: "cobertura-coverage.xml" }
}
},
istanbulOpt: {
includeUntested: true
},
webPackConfiguration: {
module: {}
},
webPackMinChunks: 3,
template: {
context: {}
}
Configuration projet
Configuration webpack
Le builder propose une configuration webpack par défaut pour les applications. Cependant, les projets sont libres de la surchager ou même de fournir leur configuration. Celle-ci doit être dans un fichier à la racine du projet :
webpack.config.js
: Ce fichier doit contenir toute la configuration webpack dont a besoin le projet. Il doit exporter une fonction et retourner la configuration à utiliser. Si ce fichier est présent, aucune configuration du builder ne sera usitée. Il est possible de le décliner par environnement par exemplewebpack.config.prod.js
,webpack.config.dev.js
etc, avec la valeur de la variable d'environnement NODE_ENV.
module.exports = (project, conf, helper, webpackConfigPart) => {
return {
// Retourner la config complète de l'application
}
}
webpack.addons.config.js
: Pour fournir une partie de la configuration ou surchager celle du builder, utiliser plutôt le fichierwebpack.addons.config.js
. Ce dernier doit exporter une fonction et retourner la configuration à utiliser. Il est également possible de le décliner par environnement par exemplewebpack.addons.config.prod.js
,webpack.addons.config.dev.js
etc, avec la valeur de la variable d'environnement NODE_ENV.
module.exports = (project, conf, helper, webpackConfigPart, configuration) => {
return {
...configuration,
"node": {
"global": true,
"process": true,
"__filename": true,
"__dirname": true,
"Buffer": true,
"setImmediate": true,
"cluster": "empty",
"child_process": "empty"
}
}
}
NB: Le builder ne fait pas de merge entre la configuration fournie et celle qu'elle propose. Il passe en argument de la fonction sa configuration. Le projet a la responsabilité de renvoyer dans l'objet retourné toute sa configuration.
Configuration karma
Le builder propose une configuration karma par défaut pour les applications. Cependant, les projets sont libres de la surchager ou même de fournir la configuration complète. Les projets qui souhaitent fournir une configuration karma spécifique doivent la décrire dans un des fichiers suivants à la racine :
karma.config.js
: Ce fichier doit contenir toute la configuration karma dont a besoin le projet. Il doit exporter une fonction et retourner la configuration à utiliser. Si ce fichier est présent, aucune configuration du builder ne sera usitée. Il est possible de le décliner par environnement par exemplekarma.config.prod.js
,karma.config.dev.js
etc, avec la valeur de la variable d'environnement NODE_ENV.
Exemple:
module.exports = (project, conf, helper, webpackConfigPart) => {
return {
// Retourner la config karma complète de l'application
}
}
karma.addons.config.js
: Ce fichier est utilisé pour fournir une configuration spécifique ou surchager celle proposée par le builder. Il doit exporter une fonction et retourner la configuration à utiliser. Il est également possible de le décliner par environnement par exemplekarma.addons.config.prod.js
,karma.addons.config.dev.js
.etc, avec la valeur de la variable d'environnement NODE_ENV.
const path = require("path");
module.exports = (karmaConfig) => {
return {
...karmaConfig,
browsers: ["FirefoxHeadless"],
customLaunchers: {
FirefoxHeadless: {
base: 'Firefox',
flags: ['-headless'],
},
},
template: {
debug: "./test/template/debug.html",
context: "./test/template/context.html",
clientContext: "./test/template/client_with_context.html"
},
clientContext: [
[/moment[\/\\]locale$/, /fr|en/],
[/intl[\/\\]locale-data[\/\\]jsonp$/, /((fr)|(en))$/],
[/^\.$/, (context) => {
if (!/\/log4js\/lib$/.test(context.context)) return;
context.regExp = /^\.\/appenders\/console.*$/;
context.request = ".";
}]
],
clientExclude: {
modules: ["cluster", "continuation-local-storage"]
}
};
}
NB: Le builder ne fait pas de merge entre la configuration fournie et celle qu'elle propose. Il passe en argument de la fonction sa configuration. Le projet a la responsabilité de renvoyer dans l'objet retourné toute sa configuration.
Les tâches fournies par hornetbuilder
Les tâches de gestion des dépendances
hornetbuilder
fourni les tâches suivantes afin de gérer les dépendances d'un projet :
Tâche | Rôle | Dépendances |
---|---|---|
dependencies:clean-all | supprime toutes les dépendances et le package-lock.json | |
dependencies:clean | supprime les dépendances (contenu du répertoire node_modules) | |
dependencies:install | lance la commande npm install --prod | |
dependencies:install-dev | Lance la commande npm install --dev | |
dependencies:install-link | Lance la commande npm link --prod | |
dependencies:install-dev-link | Lance la commande npm link --dev | |
dependencies:install-ci-prod | Lance la commande npm ci --prod | |
dependencies:install-ci-dev | Lance la commande npm ci --dev | |
dependencies:dedupe | Lance la commande npm dedupe afin de dédupliquer les dépendances présentes dans le node_modules | |
install | install les dépendances de l'application | dependencies:install, dependencies:install-link, dependencies:install-dev, dependencies:install-dev-link, dependencies:dedupe |
versions:set | permet de changer la version du projet | |
versions:get | permet de récupérer les versions du projet | |
dependency:set | permet de changer la version d'un module de dépendance du projet | |
dependency:set-snapshot | permet de changer la version d'un module de dépendance du projet avec une version snapshot | versions:get |
Les tâches de compilation
hornetbuilder
fourni les tâches suivantes afin de compiler les sources d'un projet :
Tâche | Rôle | Dépendances |
---|---|---|
compile:ts | Transpile les sources TS en Javascript.S'exécute uniquement si l'option "-i" (--ide) n'est pas utilisée. | clean |
compile | Transpile les sources TS en Javascript. Cette tâche exécutera un dependencies:install en plus de la tâche clean de la commande compile:ts | dependencies:installcompile:ts |
Les tâches de test
hornetbuilder
fourni les tâches suivantes afin d'exécuter les tests d'un projet :
Tâche | Rôle | Dépendances |
---|---|---|
prepare:testSources | Copie les sources originales et compilées dans le répertoire de travail des tests : istanbul | compile |
test:instrument | Défini les instruments de couverture de code sur les sources | prepare:testSources |
test | Exécute les tests unitaires et la mesure de couverture de code | dependencies:installtest:instrument |
test:karma | Exécute les tests basées sur KarmaJs | dependencies:installcompile |
test:mocha | Exécute les tests basées sur MochaJs | dependencies:installcompile |
test:merge-reports | Merge des rapports de test Mocha/Karma | clean-test:merge |
test:remap-reports | Remap des rapports mergés sur les sources TypeScript | clean-test:remap |
Les tâches de nettoyage
hornetbuilder
fournit les tâches suivantes afin de nettoyer un projet :
Tâche | Rôle | Répertoire/fichier | Dépendances |
---|---|---|---|
clean | Supprime les fichiers générés (.js, .map et .d.ts dans le dossier de sources) | "clean:src", "clean:test" | |
clean:build | Supprime le répertoire de build | ./target | |
clean:test | Supprime le dossier istanbul ainsi que les fichiers générés (.js, .map et .d.ts dans le dossier de tests) | test, test_report, karma_html | |
clean:static | Supprime les fichiers statics générés par webpack | ./static/js | |
clean:static-dll | Supprime les fichiers dll statics générés par webpack | ./static/js/dll | |
clean:static-all | Supprime les fichiers dll statics générés par webpack + les dll | ./static/js/dll/* | |
clean:theme | Supprime le thème de l'application dans le répêrtoire static | ./static/themeName | |
clean:src | Supprime les fichiers généré dans le répertoire source ./src | extended/.js", "**/.json", "*/.jsx | |
clean:template | Supprime les templates générées dans la partie static | ./static/templateDir | |
clean-all | Supprime tous les fichiers et dépendances | "clean", "clean:build", "dependencies:clean-all", "clean:static", "clean:template" |
Les tâches de construction des livrables
hornetbuilder
fourni les tâches suivantes afin de construire les livrables d'un projet :
Tâche | Rôle | Dépendances |
---|---|---|
prepare-package-dll | Lance WebPack pour la construction des dll's js client | |
prepare-package | Lance WebPack pour la construction du js client en mode production et copie les livrables dans le répertoire target | prepare-package:minified, prepare-all-package |
prepare-package:dev | Lance WebPack pour la construction du js client en mode debug et copie les livrables dans le répertoire target | prepare-package:minified, prepare-all-package |
prepare-package:minified | Lance WebPack avec la minification pour la construction du js client, mode Production par défaut | |
prepare-package-spa | Prépare les fichiers à packager pour un projet en FullSpa mode Production | |
prepare-package-spa:dev | Prépare les fichiers à packager pour un projet en FullSpa mode Dev | |
prepare-all-package | copie les livrables dans le répertoire target | |
template-html | Lance le templating html | |
zip-static | Construit le livrable statique (zip) | |
zip-dynamic | Construit le livrable dynamique (zip) | |
zip-environment | Construit le livrable environment (zip) | |
zip-database | Construit le livrable database (zip) | |
package-zip-static | Construit le livrable statique (zip) | prepare-package-client:minified, zip-static |
package-zip-dynamic | Construit le livrable dynamique (zip) | prepare-package-client:minified, zip-dynamic |
package-zip-static:dev | Construit le livrable statique (zip) | prepare-package-client:dev, zip-static |
package-zip-dynamic:dev | Construit le livrable dynamique (zip) | prepare-package-client:dev, zip-dynamic |
package | Package global de l'application en mode Production | compile, test, template-html, prepare-package, zip-static, zip-dynamic, zip-environment, zip, database |
package:dev | Package global de l'application en mode Dev | compile, test, template-html, prepare-package:dev, zip-static, zip-dynamic, zip-environment, zip, database |
package-spa | Package SPA de l'application en mode Production | compile, test, template-html, prepare-package-spa, zip-static, zip-dynamic, zip-environment, zip, database |
package-spa:dev | Package SPA de l'application en mode Dev | compile, test, template-html, prepare-package-spa:dev, zip-static, zip-dynamic, zip-environment, zip, database |
Les tâches de watch
hornetbuilder
fourni les tâches suivantes afin d'outiller le démarrage d'une application en développement
Tâche | Rôle | Dépendances |
---|---|---|
watch:ts | Ecoute les modifications sur les fichiers TS et les recompile à la volée.S'exécute uniquement si l'option "-i" (--ide) n'est pas utilisée | |
watch:serveur | Ecoute les modifications sur les fichiers et redémarre le serveur node pour les prendre en compte.Démarre nodejs en mode development | watch:ts |
watch:serveur-prod | Equivalent à watch:serveur mais avec nodejs en mode production | watch:ts |
watch:client | Ecoute les modifications sur les fichiers et relance WebPack à la volée.Lance WebPack en mode development. | watch:ts |
watch:client-prod | Equivalent à watch:client mais avec WebPack en mode production | watch:ts |
watch | Compile et écoute les modifications pour redémarrer nodejs et relancer WebPack si besoin.mode : development | compilewatch:clientwatch:serveur |
watch-prod | Compile et écoute les modifications pour redémarrer nodejs et relancer WebPack si besoin.mode : production | compilewatch:client-prodwatch:serveur-prod |
w | Alias de "watch" | watch |
wp | Alias de "watch-prod" | watch-prod |
Les tâches de qualimétrie
hornetbuilder
fourni les tâches suivantes afin de construire des rapports de qualimétrie :
Tâche | Rôle | Dépendances |
---|---|---|
lint | Lance le tslint sur les sources ts (qualité de code) |
hb lint
hb lint --lintReport json
Le cycle de vie d'un projet
Première utilisation du builder
Lors de la première utilisation du builder et peu importe la commande, le builder va installer les dépendances de construction/test afin que celles-ci soient disponibles dans le fichier builder.js
. Cela permet d'ajouter à un projet des tâches de construction dépendantes de modules non fournis par le framework. Il sera ainsi possible d'écrire dans le fichier builder.js
:
var maDependanceSpecifique = require("maDependanceSpecifique");
En cours de développement
Dès la première utilisation du builder sur un projet, il est possible d'utiliser la commande :
hb watch
Dans un ide qui compile automatiquement les fichiers typescript, il est recommandé d'utiliser l'option -i
hb watch -i
ou bien :
hb w -i
Les dépendances entre les tâches du builder font que l'arbre des dépendances applicatives va être calculé, que les versions non fixées vont l'être, que l'ensemble des dépendances vont s'installer, que les sources vont se compiler, que le serveur nodejs va démarrer et que les modifications des fichiers seront écoutées.
Il est néanmoins possible de lancer indépendemment les différentes tâches :
hb dependencies:install
hb compile
hb watch
Lancement des tests
MochaJs
hb test
Exécute les tests et fournit sur la console :
- la description de chaque test exécuté
- le nombre de tests OK et KO
- si tous les tests sont OK : le taux de couverture de code total et fichier par fichier
Les fichiers exécutés doivent se trouver dans le répertoire ./test et se nommer *-spec.js sachant que la phase de compile passe avant.
KarmaJs
hb test:karma
hb test:karma --file ./test/page/test.karma.js
Le test à exécuter est donné par le paramètre -file ou si aucun n'est précisé, il prend la configuration karma et par défaut c'est tests.webpack.js. Ce dernier référence tous les tests à exécuter grace à require, exemple qui tire tous les fichiers *.karma.js dans le répertoire test:
var context = require.context('./test', true, /\.karma\.js$/);
context.keys().forEach(context);
Les rapports sont générés dans le répertoire ./test_report
Le navigateur utilisé par défaut est Firefox. Pour en ajouter ou en utiliser un autre, il faut surcharger la configuration dans le fichier karma.addons.config.js ou dans karma.config.js ou dand karma.addons.config.env.js ou dans karma.config.env.js, exemple :
config : {
....
..
karma: {
browsers: ["Chrome", "Firefox"],
}
}
Par défaut, lorsque les tests sont ouverts dans un navigateur, aucune feuille de style hornet n'est chargée. Il est possible de surcharger les templates karma:
config : {
....
..
karma: {
template: {
debug: "./test/template/debug.html",
context: "./test/template/context.html",
clientContext: "./test/template/client_with_context.html"
}
}
}
les templates fournis nécessitent de démarrer un serveur de thèmes.
Templating Html
hb template-html
Lance le templating basé sur EJS et écrit les fichiers dans 'static/html' du projet.
Si l'objet de configuration tempate est un tableau, il lancera autant de templating que d'élément dans le tableau, exemple :
template: [
{
context: [{error: "404", suffixe: "_404", message: "Oops! Nous ne trouvons pas ce que vous cherchez!"}, {error: "500", suffixe: "_500", message: "Oops! Une erreur est survenue!"}],
dir: "./template/error",
dest: "/error"
}, {
context: {message: "test template"}
}
]
Dans cet exemple, le templating suivant est lancé :
- Sur le répertoire "./template/error" et autant de fois que d'item dans l'attribut context (2). Les fichiers seront suffixés par l'attibut suffixe de chaque contexte (_404, _500) et générés dans le répertoire error (attibut dest) dans static/html du projet.
- Sur le répertoire "./template" (valeur par défaut)
Construction des livrables
hb package
Construit les différents livrables et les place dans le répertoire target
à la racine du projet.
Publication
hb publish --publish-registry <URL>
Publie le module sur un repository spécifique.
Changement de version
hb versions:set --versionFix=1.2.3
Modifie la version du projet ou des projets si on est sur un type parent en '1.2.3'.
hb versions:set --versionFix=
Modifie la version du projet en suffixant par un timestamp 'YYYYMMDDHHmmss'.
hb versions:set --versionFix=RC
Modifie la version du projet en suffixant la prochaine version 'RC' trouvé sur le repository de publication.
hb versions:set --versionFix=\'-123\'
Modifie la version du projet en suffixant par '-123', il faut echapper les caractères `.
Changement de version d'une dépendance
hb dependency:set --versionFix=1.2.3 --dependencyVersionFix=monpackage
Reprend les principes de versions:set
mais sur les dépendances d'un projet.
Changement de version d'une dépendance en snapshot
hb dependency:set-snapshot --dependencyVersionFix=monpackage --module=monpackage
Recherche de dernière version d'une dépendance
hb versions:get --versionSearch=5.0.2 --module=hornet-js-core
Retourne la dernière version commencant par 5.0.2 du module hornet-js-core, exemple : 5.0.2-20180109183247. Si le module n'est pas renseigné, c'est sur le projet lui-même que la recherche est faite, et si versionSearch
n'est pas renseigné c'est la dernière version qui est retournée (sans contrainte de préfixe)
hb versions:get --versionSearch=snapshot --module=hornet-js-core
Permet d'avoir la dernière version snapshot d'un module présent dans les dépendances du projet (appDependencies, buildDependencies, ...).
Tâches SASS
2 tâches sont prévues pour manipuler des fichiers SCSS:
hb process:sass
Cette tâche permet de générer un fichier CSS (par défaut, le fichier sera ./static/css/generated.css
comme indiqué dans la conf.)
hb watch:sass
Cette tâche permet de générer un fichier CSS puis de watcher les modifications des fichiers SCSS pour re-générer au besoin le fichier CSS.
Par défaut, cette tâche est rattachée à la tâche de watch:client
.
Si l'application est démarée via la commande hb w
, la tâche watch:sass
sera donc exécutée et n'importe quelle modification de fichier .scss
entrainera une génération des nouveaux .css
et un redémarrage du nodemon.
Les tâches liées à SASS reposent sur la librairie gulp-sass-image
laquelle génère par défaut un fichier ./static/css/_sass-image.scss
. Ce dernier contient des méthods utiles afin de manipuler les images (cf. ). Ce fichier généré repose sur un template mustache
qui'il est possible de surcharger.
Approche Composant
Il est également possible de générer des fichiers CSS à partir de fichiers SCSS en important ces derniers directement dans les composants React.
import * as React from "react";
import { Utils } from "hornet-js-utils";
if(!Utils.isServer) {
require("path/vers/Scss/File.scss");
}
export class MyComponent extends HornetComponent<MyComponentProps, MyComponentState> {
...
}
La déclaration d'un simple require
dans un composant .tsx
en le protégeant d'un !Utils.isServer
permettra à sass-loader
de générer le fichier CSS associé
Licence
hornet-js-builder
est sous licence cecill 2.1.
6 years ago