dgeni-packages
Advanced tools
dgeni-packages - npm Package Compare versions
Comparing version 0.10.0-rc.3 to 0.10.0-rc.4
| # Changelog | ||
| ## v0.10.0-rc.4 12th September 2014 | ||
| Bug Fixes: | ||
| * fix(examples/generateExamplesProcessor): manifest files should be an array of strings caf321ec | ||
| * fix(ngdoc/memberDocs): strip modifier from member name b0b53ec5 | ||
| ## v0.10.0-rc.3 11th September 2014 | ||
@@ -5,0 +12,0 @@ |
@@ -136,4 +136,7 @@ var _ = require('lodash'); | ||
| var files = _(example.files) | ||
| .keys() | ||
| .omit('index.html'); | ||
| .omit('index.html') | ||
| .map(function(file) { | ||
| return file.name; | ||
| }) | ||
| .value(); | ||
@@ -140,0 +143,0 @@ var manifestDoc = { |
@@ -101,3 +101,4 @@ var _ = require('lodash'); | ||
| expect(manifestDoc.example).toEqual(exampleMap.get('a.b.c')); | ||
| expect(manifestDoc.files).toEqual(['app.js', 'app.css', 'app.spec.js']); | ||
| }); | ||
| }); |
@@ -29,3 +29,4 @@ var _ = require('lodash'); | ||
| doc.memberof = parts[0]; | ||
| doc.name = parts[1]; | ||
| // remove the 'method:', 'property:', etc specifier from the id part | ||
| doc.name = parts[1].replace(/^.*:/, ''); | ||
@@ -32,0 +33,0 @@ log.debug('child doc found', doc.id, doc.memberof); |
@@ -41,2 +41,3 @@ var mockPackage = require('../mocks/mockPackage'); | ||
| expect(doc3.name).toEqual('warn'); | ||
| expect(doc3.memberof).toEqual('module:ng.service:$log'); | ||
@@ -43,0 +44,0 @@ expect(doc1.methods).toEqual([doc3]); |
| { | ||
| "name": "dgeni-packages", | ||
| "version": "0.10.0-rc.3", | ||
| "version": "0.10.0-rc.4", | ||
| "description": "A collection of dgeni packages for generating documentation from source code", | ||
@@ -5,0 +5,0 @@ "scripts": { |
| # Dgeni Packages | ||
| Ce dépôt contient une collection de packages de Dgeni qui peuvent être utilisés par Dgeni, le générateur | ||
| Ce dépôt contient une collection de **Packages** de Dgeni qui peuvent être utilisés par Dgeni, le générateur | ||
| de documentation, pour créer une documentation à partir du code source. | ||
@@ -17,3 +17,3 @@ | ||
| * examples - Processeurs pour supporter les exemples exécutables qui figurent sur les docs du site d'angular.js. | ||
| * dgeni - support pour la documentation des packages de Dgeni | ||
| * dgeni - support pour la documentation des packages de Dgeni (**incomplet**) | ||
@@ -24,7 +24,9 @@ ## Le package `base` | ||
| * `computeIdsProcessor` - Détermine le `id` et le `aliases` pour les documents en utilisant des templates ou des fonctions | ||
| d'aide, sur la base du `docType`. | ||
| * `computePathsProcessor` - Détermine le `path` et le `outputPath` des documents en utilisant des templates ou des fonctions | ||
| d'aide, sur la base du `docType`. | ||
| * `debugDumpProcessor` - extrait l'état courant du tableau docs dans un fichier (désactivé par défaut) | ||
| * `readFilesProcessor` - utilisé pour charger les documents depuis les fichiers. Ce processeur peut-être configuré pour utiliser | ||
| un ensemble de **lecteur de fichier**. Il y a des lecteurs de fichiers (file-readers) dans les packages `jsdoc` et `ngdoc`. | ||
| * `computePathsProcessor` - Détermine le `path` et le `outputPath` des documents en utilisant des templates ou des fonctions | ||
| d'aide, sur la base du `docType`. | ||
| * `renderDocsProcessor` - rendre les documents dans une propriété (`doc.renderedContent`) en utilisant | ||
@@ -38,2 +40,4 @@ un `templateEngine` (moteur de template), qui doit être fourni séparément - voir le package `nunjucks`. | ||
| * `aliasMap` - Un map de ids/aliases pour les docs. C'est utilisé pour faire correspondre les références aux documents dans | ||
| des liens et des relations tels que les modules et les membres de l'objet. | ||
| * `createDocMessage` - une aide pour créer de beaux messages à prpopos des documents (utile pour les logs et | ||
@@ -45,5 +49,8 @@ les erreurs) | ||
| de texte. | ||
| * `writeFile` - Ecrit du contenu dans un fichier, en s'assurant que le chemin du fichier existe. | ||
| Le template utilisé pour rendre le doc est déterminer par `templateFinder`, celui-ci utilise le premier qui correspond | ||
| #### Recherche du Template | ||
| Le template utilisé pour rendre un doc est déterminer par `templateFinder`, celui-ci utilise le premier qui correspond | ||
| à un ensemble de patterns dans un ensemble de dossiers, fourni dans la configuration. Cela permet pas mal de contrôle pour fournir | ||
@@ -89,5 +96,5 @@ des templates génériques pour la plupart des situations et des templates spécifiques pour des cas exceptionnels. | ||
| dans le fichier source. | ||
| * `parseTagsProcessor` - utilise un `tagParser` pour analyser les balises de jsdoc dans le contenu du document. | ||
| * `extractTagsProcessor` - utilise un `tagExtractor` pour extraire l'information depuis les balises analysées. | ||
| * `inlineTagsProcessor` - recherche les docs pour les balises [`inline`](http://usejsdoc.org/about-inline-tags.html) qui ont besoin d'avoir de l'injection de contenu | ||
| * `parseTagsProcessor` - utilise un `tagParser` pour analyser les balises de jsdoc dans le contenu du document. | ||
@@ -124,3 +131,5 @@ ### Définitions des balises | ||
| Le package `ngdoc` dépend des packages `jsdoc` et `nunjucks`. | ||
| Le package `ngdoc` dépend des packages `jsdoc` et `nunjucks`. Il offre un support complémentaire pour | ||
| les documents non-API écrits dans les fichiers avec l'extension `.ngdoc`. Il détermine également des propriétés | ||
| supplémentaires spécifiques au code correspondant à Angular. | ||
@@ -133,34 +142,18 @@ ### Les lecteurs de fichier | ||
| * `apiDocsProcessor` - | ||
| * `filterNgdocsProcessor` - | ||
| Pour AngularJS, nous sommes seulement intéressés aux documents qui contiennent les balises @ngdoc. Ce processeur | ||
| supprime les docs qui ne contiennent pas cette balise. | ||
| Ce processeur exécute des processus qui sont spécifiquement liées à la documentation pour les composants de l'API. Il fait ce qui suit : | ||
| - Détermine le nom du package pour le module (par exemple angular ou angular-sanitize) | ||
| - Collecte tous les documents qui appartiennent au module | ||
| - Les attache à la doc du module dans la propriété `components` | ||
| - Détermine le chemin de l'URL vers le document dans l'application docs et le chemin de destination (OutputPath) du fichier final | ||
| - Il relie les documents des services d'angular avec les documents des provider correspondant. | ||
| apiDocsProcessor a les options de configuration suivantes de disponibles (énumérés avec les valeurs par défaut) : | ||
| ```js | ||
| apiDocsProcessor.apiDocsPath = undefined; // C'est une propriété obligatoire qui doit être définie | ||
| apiDocsProcessor.outputPathTemplate = '${area}/${module}/${docType}/${name}.html', // Le chemin pour écrire la page d'un document de l'api. | ||
| apiDocsProcessor.apiPathTemplate = '${area}/${module}/${docType}/${name}', // L'url pour la page du document. | ||
| apiDocsProcessor.moduleOutputPathTemplate = '${area}/${name}/index.html', // Le chemin pour écrire la page d'un module de l'api. | ||
| apiDocsProcessor.modulePathTemplate = '${area}/${name}' // L'url pour la page du module. | ||
| ``` | ||
| * `generateComponentGroupsProcessor` - | ||
| Génère des documents pour chaque groupe de composants (par type) dans un module | ||
| * `computeIdProcessor` - | ||
| Détermine la propriété id du doc sur la base des balises et d'autres méta-données | ||
| * `memberDocsProcessor` - Ce processeur relie les docs qui sont membres (propriétés, méthodes et événements) à | ||
| leurs docs contenants, et les retire de la collection des docs principaux. | ||
| * `filterNgdocsProcessor` - | ||
| Pour AngularJS, nous sommes seulement intéressés aux documents qui contiennent les balises @ngdoc. Ce processeur | ||
| supprime les docs qui ne contiennent pas cette balise. | ||
| * `moduleDocsProcessor` - Ce processeur détermine les propriétés pour les docs des modules tels que `packageName` et | ||
| `packageFileName`. Il ajoute les modules au service `moduleMap` et relie tous les docs qui sont dans un module | ||
| au doc du moduledans la propriété `components` | ||
| * `collectPartialNames` - | ||
| Ajoute tous les docs à `partialNameMap` | ||
| * `providerDocsProcessor` - Ce processeur lie les documents sur les services angular au document de leur | ||
| provider correspondant. | ||
@@ -170,3 +163,5 @@ | ||
| Ce package modifie et ajoute de nouvelles définitions de balises en plus de celles fournies par le package `jsdoc`. | ||
| Ce package modifie et ajoute de nouvelles définitions de balises en plus de celles fournies par le package `jsdoc` : | ||
| `area`, `element`, `eventType`, `example`, `fullName`, `id`, `module`, `name`, `ngdoc`, packageName`, | ||
| `parent`, `priority`, `restrict`, `scope` et `title`. | ||
@@ -182,9 +177,7 @@ | ||
| * `getAliases()` - Récupère une liste de tous les alias qui peuvent être faits à partir de la doc fournie | ||
| * `getDocFromAliases()` - Trouve un document depuis `aliasMap` qui correspond à l'alias donné | ||
| * `getLinkInfo()` - Récupère les informations du lien depuis un document qui correspond à l'url donné | ||
| * `getPartialNames()` - Récupère une liste de tous les noms de code de partiel qui peuvent être utilisés à partir d'un ensemble | ||
| donné | ||
| * `gettypeClass()` - Récupère un string de classe CSS pour un string de type donné | ||
| * `moduleMap` - Une collection de modules correspondant au nom du module | ||
| * `parseCodeName()` - Découpe le nom de code en plusieurs morceaux | ||
| * `patialNameMap` - Une map de nom de partiel pour les docs | ||
| * `moduleMap` - Une collection de modules correspondant à l'id du module | ||
@@ -243,10 +236,9 @@ | ||
| * `parseExamplesProcessor` - | ||
| Analyse les balises `<example>` depuis le contenu et les ajoute au service `examples` | ||
| * `generateExamplesProcessor` - | ||
| Ajoute les nouveaux docs à la collection de docs pour chaque exemple dans le service `examples` qui sera rendue | ||
| comme des fichiers qui peuvent être exécutés dans le navigateur, par exemple en direct des démos ou pour | ||
| * `generateExamplesProcessor` - Ajoute les nouveaux docs à la collection de docs pour chaque exemple dans le service `examples` qui sera rendue | ||
| comme des fichiers qui peuvent être exécutés dans le navigateur, par exemple des démos en direct ou pour | ||
| des tests de e2e. | ||
| * `parseExamplesProcessor` - Analyse les balises `<example>` depuis le contenu et les ajoute au service `examples` | ||
| * `generateProtractorTests` - Génère les fichiers de test de protractor depuis les tests e2e dans les exemples | ||
| ### Définitions des balises Inline | ||
@@ -253,0 +245,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.14%
301600
- Lines of code
- increased by0.1%
5809
No dependency changes