From cc42169d149b9813d624b8c8184b78b9911e634a Mon Sep 17 00:00:00 2001 From: Eugenio Romano Date: Wed, 5 Jul 2017 19:35:07 +0200 Subject: [PATCH] add markdown linter (#2048) --- ng2-components/.markdownlintrc | 10 +++ ng2-components/README.md | 52 ++++++++-------- .../ng2-activiti-processlist/README.md | 4 +- .../ng2-activiti-tasklist/README.md | 7 ++- ng2-components/ng2-alfresco-core/README.md | 28 +++------ .../ng2-alfresco-datatable/README.md | 52 ++++++++-------- .../ng2-alfresco-documentlist/README.md | 9 ++- ng2-components/ng2-alfresco-viewer/README.md | 2 - .../ng2-alfresco-webscript/README.md | 8 +-- ng2-components/package-base.json | 6 +- ng2-components/package-lock.json | 62 +++++++++++++++++++ ng2-components/package.json | 10 +-- 12 files changed, 156 insertions(+), 94 deletions(-) create mode 100644 ng2-components/.markdownlintrc diff --git a/ng2-components/.markdownlintrc b/ng2-components/.markdownlintrc new file mode 100644 index 0000000000..83b34a7de7 --- /dev/null +++ b/ng2-components/.markdownlintrc @@ -0,0 +1,10 @@ +{ + "MD032": false, + "MD004": false, + "MD024": false, + "MD009": false, + "MD013": false, + "MD036": false, + "MD033" : false, + "MD031" : false +} diff --git a/ng2-components/README.md b/ng2-components/README.md index 92e0da61b7..f60a2813a9 100644 --- a/ng2-components/README.md +++ b/ng2-components/README.md @@ -31,84 +31,82 @@ - [adf-context-menu](ng2-alfresco-core/README.md) -- [adf-mdl-menu](ng2-alfresco-core/README.md) - [adf-mdl-textfield](ng2-alfresco-core/README.md) +- [adf-mdl-menu](ng2-alfresco-core/README.md) - [adf-mdl-button](ng2-alfresco-core/README.md) - [adf-upload](ng2-alfresco-core/README.md) -## Content service +## Content service ### Components -- [adf-userinfo](ng2-alfresco-userinfo/README.md) +- [adf-search-autocomplete](ng2-alfresco-search/README.md) +- [adf-search-control](ng2-alfresco-search/README.md) +- [adf-search](ng2-alfresco-search/README.md) - [adf-viewer](ng2-alfresco-viewer/README.md) +- [adf-userinfo](ng2-alfresco-userinfo/README.md) - [adf-file-uploading-list](ng2-alfresco-upload/README.md) - [adf-upload-button](ng2-alfresco-upload/README.md) - [adf-upload-drag-area](ng2-alfresco-upload/README.md) - [adf-tag-node-list](ng2-alfresco-tag/README.md) -- [adf-tag-list](ng2-alfresco-tag/README.md) - [adf-tag-node-actions-list](ng2-alfresco-tag/README.md) -- [adf-login](ng2-alfresco-login/README.md) -- [adf-search-autocomplete](ng2-alfresco-search/README.md) -- [adf-search-control](ng2-alfresco-search/README.md) -- [adf-search](ng2-alfresco-search/README.md) -- [adf-like](ng2-alfresco-social/README.md) +- [adf-tag-list](ng2-alfresco-tag/README.md) - [adf-rating](ng2-alfresco-social/README.md) -- [adf-webscript-get](ng2-alfresco-webscript/README.md) +- [adf-like](ng2-alfresco-social/README.md) - [adf-breadcrumb](ng2-alfresco-documentlist/README.md) - [adf-document-menu-action](ng2-alfresco-documentlist/README.md) - [adf-document-list](ng2-alfresco-documentlist/README.md) +- [adf-login](ng2-alfresco-login/README.md) +- [adf-webscript-get](ng2-alfresco-webscript/README.md) - [adf-pagination](ng2-alfresco-datatable/README.md) - [adf-datatable](ng2-alfresco-datatable/README.md) - [adf-datatable-cell](ng2-alfresco-datatable/README.md) - -## Business service +## Business service ### components -- [adf-publish-task](ng2-activiti-diagrams/README.md) -- [adf-publish-task](ng2-activiti-diagrams/README.md) -- [adf-create-task-attachment](ng2-activiti-tasklist/README.md) +- [adf-diagram-icon-publish-task](ng2-activiti-diagrams/README.md) +- [adf-diagram-publish-task](ng2-activiti-diagrams/README.md) +- [adf-start-form](ng2-activiti-form/README.md) +- [adf-content](ng2-activiti-form/README.md) +- [adf-form-list](ng2-activiti-form/README.md) +- [adf-form](ng2-activiti-form/README.md) - [adf-people-list](ng2-activiti-tasklist/README.md) -- [adf-task-attachment-list](ng2-activiti-tasklist/README.md) +- [adf-create-task-attachment](ng2-activiti-tasklist/README.md) - [adf-people-search](ng2-activiti-tasklist/README.md) - [adf-start-task](ng2-activiti-tasklist/README.md) -- [adf-task-details](ng2-activiti-tasklist/README.md) - [adf-filters](ng2-activiti-tasklist/README.md) +- [adf-task-details](ng2-activiti-tasklist/README.md) - [adf-task-header](ng2-activiti-tasklist/README.md) - [adf-people](ng2-activiti-tasklist/README.md) +- [adf-task-attachment-list](ng2-activiti-tasklist/README.md) - [adf-comments](ng2-activiti-tasklist/README.md) +- [adf-apps](ng2-activiti-tasklist/README.md) - [adf-checklist](ng2-activiti-tasklist/README.md) - [adf-tasklist](ng2-activiti-tasklist/README.md) -- [adf-apps](ng2-activiti-tasklist/README.md) - [adf-process-instance-comments](ng2-activiti-processlist/README.md) -- [adf-process-instance-variables](ng2-activiti-processlist/README.md) - [adf-process-instance-tasks](ng2-activiti-processlist/README.md) +- [adf-process-instance-variables](ng2-activiti-processlist/README.md) - [adf-process-instance-header](ng2-activiti-processlist/README.md) - [adf-diagram](ng2-activiti-diagrams/README.md) - [adf-create-process-attachment](ng2-activiti-processlist/README.md) -- [adf-process-attachment-list](ng2-activiti-processlist/README.md) - [adf-start-process](ng2-activiti-processlist/README.md) - [adf-process-instance-details](ng2-activiti-processlist/README.md) -- [adf-process-instance-list](ng2-activiti-processlist/README.md) +- [adf-process-attachment-list](ng2-activiti-processlist/README.md) - [adf-process-instance-filters](ng2-activiti-processlist/README.md) -- [adf-start-form](ng2-activiti-form/README.md) -- [adf-content](ng2-activiti-form/README.md) -- [adf-form](ng2-activiti-form/README.md) +- [adf-process-instance-list](ng2-activiti-processlist/README.md) - [adf-analytics-generator](ng2-activiti-analytics/README.md) - [adf-analytics](ng2-activiti-analytics/README.md) - - You can browse all the components at the following address: -http://devproducts.alfresco.com/ \ No newline at end of file +[http://devproducts.alfresco.com/](http://devproducts.alfresco.com/) \ No newline at end of file diff --git a/ng2-components/ng2-activiti-processlist/README.md b/ng2-components/ng2-activiti-processlist/README.md index 7e44cb3b1c..49e788fe3b 100644 --- a/ng2-components/ng2-activiti-processlist/README.md +++ b/ng2-components/ng2-activiti-processlist/README.md @@ -197,8 +197,7 @@ to specify some basic details needed to start a new process instance. | Name | Description | | --- | --- | | appId | (required): Limit the list of processes which can be started to those contained in the specified app | -| variables | Variables in input to the process [RestVariable]**](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md)| - +| variables | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md)| ### Events @@ -207,7 +206,6 @@ to specify some basic details needed to start a new process instance. | start | Raised when the process start | | error | Raised when the start process fail | - ## Process Details component This component displays detailed information on a specified process instance diff --git a/ng2-components/ng2-activiti-tasklist/README.md b/ng2-components/ng2-activiti-tasklist/README.md index fba35d3ca7..7d2a86c13d 100644 --- a/ng2-components/ng2-activiti-tasklist/README.md +++ b/ng2-components/ng2-activiti-tasklist/README.md @@ -176,7 +176,7 @@ The component shows the details of the task id passed in input By default the Activiti Task Details provides the following message for the empty task details: -``` +```html No Tasks ``` @@ -247,7 +247,6 @@ You can use inside the filter one of the following property } ``` - ## Activiti Filter The component shows all the available filters. @@ -281,8 +280,10 @@ If both `appId` and `appName` are specified then `appName` will take precedence + ``` + You can use inside the filterParam one of the following property. ### FilterParamsModel @@ -422,6 +423,7 @@ The purpose of the component is populate the local variable called `properties` | claim | Raised when the task is claimed. | ## TaskDetailsModel + ```json { "id": "string", @@ -431,6 +433,7 @@ The purpose of the component is populate the local variable called `properties` "description": "string" } ``` + ## Task People Component This component displays involved users to a specified task diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md index aec4a248b9..1ac570ba82 100644 --- a/ng2-components/ng2-alfresco-core/README.md +++ b/ng2-components/ng2-alfresco-core/README.md @@ -18,6 +18,9 @@ - [Alfresco Api Service](#alfresco-api-service) - [AppConfigService](#appconfigservice) * [Different configurations based on environment settings](#different-configurations-based-on-environment-settings) + * [Variable substitution in configuration strings](#variable-substitution-in-configuration-strings) + * [Unit testing](#unit-testing) +- [User Preferences Service](#user-preferences-service) - [Notification Service](#notification-service) - [Context Menu directive](#context-menu-directive) - [Accordion Component](#accordion-component) @@ -30,7 +33,6 @@ - [AlfrescoTranslationService](#alfrescotranslationservice) - [Renditions Service](#renditions-service) - [Build from sources](#build-from-sources) -- [Build from sources](#build-from-sources-1) - [NPM scripts](#npm-scripts) - [Demo](#demo) - [License](#license) @@ -41,7 +43,7 @@ ## Prerequisites -Before you start using this development framework, make sure you have installed all required software and done all the +Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). > If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI) @@ -74,17 +76,17 @@ npm install ng2-alfresco-core ## Upload Directive -Allows your components or common HTML elements reacting on File drag and drop in order to upload content. +Allows your components or common HTML elements reacting on File drag and drop in order to upload content. Used by attaching to an element or component. ### Basic usage -The directive itself does not do any file management process, +The directive itself does not do any file management process, but collects information on dropped files and raises corresponding events instead. ```html
Drop files here...
@@ -113,7 +115,7 @@ Directive supports several modes: - **drop** mode, where decorated element acts like a drop zone for files (**default** mode) - **click** mode, where decorated element invokes File Dialog to select files or folders. -It is also possible combining modes together. +It is also possible combining modes together. ```html
...
@@ -145,7 +147,7 @@ For the click mode you can provide additional attributes for the File Dialog: #### Drop mode -For the moment upload directive supports only Files (single or multiple). +For the moment upload directive supports only Files (single or multiple). Support for Folders and `accept` filters is subject to implement. ### Events @@ -162,7 +164,7 @@ The DOM event is configured to have `bubbling` enabled, so any component up the ```ts onUploadFiles(e: CustomEvent) { console.log(e.detail.files); - + // your code } ``` @@ -669,7 +671,6 @@ class MyComponent { **Important note**: `addTranslationFolder` method redirects **all** languages to a new folder, you may need implementing multiple languages or copying existing translation files to a new path. - ## Renditions Service * getRenditionsListByNodeId(nodeId: string) @@ -679,15 +680,6 @@ or copying existing translation files to a new path. ## Build from sources -Alternatively you can build component from sources with the following commands: - -```sh -npm install -npm run build -``` - -## Build from sources - You can build component from sources with the following commands: ```sh diff --git a/ng2-components/ng2-alfresco-datatable/README.md b/ng2-components/ng2-alfresco-datatable/README.md index f7983abe8f..edb56ab7f0 100644 --- a/ng2-components/ng2-alfresco-datatable/README.md +++ b/ng2-components/ng2-alfresco-datatable/README.md @@ -4,31 +4,31 @@ - * [Prerequisites](#prerequisites) - * [Install](#install) - * [Basic usage](#basic-usage) - + [DataTable Properties](#datatable-properties) - + [DataColumn Properties](#datacolumn-properties) - + [DataTable Events](#datatable-events) - + [DataTable DOM Events](#datatable-dom-events) - + [Empty content template](#empty-content-template) - + [Loading content template](#loading-content-template) - + [Column Templates](#column-templates) - + [Events](#events) - - [rowClick event](#rowclick-event) - - [rowDblClick event](#rowdblclick-event) - - [showRowContextMenu event](#showrowcontextmenu-event) - - [showRowActionsMenu event](#showrowactionsmenu-event) - - [executeRowAction event](#executerowaction-event) - * [Data sources](#data-sources) - * [Generate schema](#generate-schema) +- [Prerequisites](#prerequisites) +- [Install](#install) +- [Basic usage](#basic-usage) + * [DataTable Properties](#datatable-properties) + * [DataColumn Properties](#datacolumn-properties) + * [DataTable Events](#datatable-events) + * [DataTable DOM Events](#datatable-dom-events) + * [Empty content template](#empty-content-template) + * [Loading content template](#loading-content-template) + * [Column Templates](#column-templates) + * [Events](#events) + + [rowClick event](#rowclick-event) + + [rowDblClick event](#rowdblclick-event) + + [showRowContextMenu event](#showrowcontextmenu-event) + + [showRowActionsMenu event](#showrowactionsmenu-event) + + [executeRowAction event](#executerowaction-event) +- [Data sources](#data-sources) +- [Generate schema](#generate-schema) - [Pagination Component](#pagination-component) - + [Properties](#properties) - + [Events](#events-1) - * [Build from sources](#build-from-sources) - * [NPM scripts](#npm-scripts) - * [Demo](#demo) - * [License](#license) + * [Properties](#properties) + * [Events](#events-1) +- [Build from sources](#build-from-sources) +- [NPM scripts](#npm-scripts) +- [Demo](#demo) +- [License](#license) @@ -58,6 +58,7 @@ npm install ng2-alfresco-datatable [data]="data"> ``` + **app.component.ts** ```ts @@ -571,13 +572,12 @@ let schema = ObjectDataTableAdapter.generateSchema(data); ``` -# Pagination Component +## Pagination Component The pagination object is a generic component to paginate component. The Alfresco API are paginated and returns a Pagination object. You can use the pagination object to feed the pagination component and then listen to the event which return the current pagination and query again the API with the options choose by the user. ![DataTable demo](docs/assets/pagination-demo.png) - ### Properties | Name | Type | Default | Description diff --git a/ng2-components/ng2-alfresco-documentlist/README.md b/ng2-components/ng2-alfresco-documentlist/README.md index af5473c9f5..84267dbeb7 100644 --- a/ng2-components/ng2-alfresco-documentlist/README.md +++ b/ng2-components/ng2-alfresco-documentlist/README.md @@ -163,7 +163,7 @@ In this case you can use `alfresco-js-api` to get node details based on it's rel Let's try setting default folder to `/Sites/swsdp/documentLibrary` without knowing it's ID beforehand. For the sake of simplicity example below shows only main points you may need paying attention to: - + ```ts import { ChangeDetectorRef } from '@angular/core'; import { AlfrescoApiService } from 'ng2-alfresco-core'; @@ -284,7 +284,6 @@ DocumentList provides simple breadcrumb element to indicate the current position ***Note:*** the `` and `` are the same component you can still use the old tag name - ![Breadcrumb](docs/assets/breadcrumb.png) ### Properties @@ -317,7 +316,6 @@ When the "New Folder" button is pressed the dialog appears. ![Creation Menu Action](docs/assets/document-list-creation-menu-actions-2.png) - ## Custom columns It is possible to reorder, extend or completely redefine data columns displayed by the component. @@ -563,7 +561,6 @@ All document actions are rendered as a dropdown menu as on the picture below: ![Document Actions](docs/assets/document-actions.png) - #### Default action handlers The following action handlers are provided out-of-box: @@ -772,8 +769,8 @@ _Note that for the sake of simplicity the example code below was reduced to the ``` **View1.component.ts** -```ts +```ts import { RowFilter, ShareDataRow } from 'ng2-alfresco-documentlist'; export class View1 { @@ -817,6 +814,7 @@ Your function can return `null` or `false` values to fallback to default image r _Note that for the sake of simplicity the example code below was reduced to the main points of interest only._ **View1.component.html** + ```html @@ -830,6 +828,7 @@ _Note that for the sake of simplicity the example code below was reduced to the ``` **View1.component.ts** + ```ts import { DataColumn, DataRow } from 'ng2-alfresco-datatable'; import { ImageResolver } from 'ng2-alfresco-documentlist'; diff --git a/ng2-components/ng2-alfresco-viewer/README.md b/ng2-components/ng2-alfresco-viewer/README.md index ccdd14aedd..d24bf7c644 100644 --- a/ng2-components/ng2-alfresco-viewer/README.md +++ b/ng2-components/ng2-alfresco-viewer/README.md @@ -1,6 +1,5 @@ # Alfresco File Viewer Component - @@ -83,7 +82,6 @@ Using with file url: Note for unsupported extension the viewer will offer the possibility to convert it in PDF is that kind of extension is supported by the [content service renditions service](https://community.alfresco.com/docs/DOC-5879-rendition-service) - ## Custom extension handler If you want handle other file formats that are not yet supported by the ng2-alfresco-viewer you can define your own custom handler. diff --git a/ng2-components/ng2-alfresco-webscript/README.md b/ng2-components/ng2-alfresco-webscript/README.md index a100bbc1c0..1364582387 100644 --- a/ng2-components/ng2-alfresco-webscript/README.md +++ b/ng2-components/ng2-alfresco-webscript/README.md @@ -20,7 +20,6 @@ - ## Prerequisites Before you start using this development framework, make sure you have installed all required software and done all the @@ -85,7 +84,6 @@ export class AppComponent { | onSuccess | event | | You can get the plain data from the webscript through the **onSuccess** event parameter and use it as you need in your application | | showData | booleann | true | render the webscript data | - **contentType** {string} ***data*** {string} data contain the plain value get from the webscipt is an output parameter @@ -94,7 +92,7 @@ export class AppComponent { This sample demonstrates how to implement a Webscript component that renders the HTML contents that come from a webscript This sample Web Scripts reside in your Alfresco Server AND you can access the folder webscript here: -http://localhost:8080/alfresco/service/sample/folder/Company%20Home +```http://localhost:8080/alfresco/service/sample/folder/Company%20Home``` ```html package.json", "test": "node node_modules/karma/bin/karma start --reporters mocha,coverage --single-run --component .", "test-browser": "node node_modules/karma/bin/karma start karma.conf.js --reporters kjhtml", "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md && markdown-toc -i README.md", - "doc": "npm run toc && npm run npm run webpack -- --config config/webpack.doc.js --progress --profile --bail", + "markdownlint": "markdownlint ng2-alfresco-core/README.md && markdownlint ng2-alfresco-datatable/README.md && markdownlint ng2-activiti-diagrams/README.md && markdownlint ng2-activiti-analytics/README.md && markdownlint ng2-activiti-form/README.md && markdownlint ng2-activiti-tasklist/README.md && markdownlint ng2-activiti-processlist/README.md && markdownlint ng2-alfresco-documentlist/README.md && markdownlint ng2-alfresco-login/README.md && markdownlint ng2-alfresco-search/README.md && markdownlint ng2-alfresco-tag/README.md && markdownlint ng2-alfresco-upload/README.md && markdownlint ng2-alfresco-viewer/README.md && markdownlint ng2-alfresco-webscript/README.md && markdownlint ng2-alfresco-webscript/README.md && markdownlint ng2-alfresco-userinfo/README.md && markdownlint ng2-alfresco-social/README.md && markdownlint README.md", + "doc": "npm run toc && npm run markdownlint && npm run npm run webpack -- --config config/webpack.doc.js --progress --profile --bail", "tslint": "", "prepublish": "", "tsc": "", @@ -69,6 +70,7 @@ "karma-systemjs": "^0.16.0", "karma-webpack": "^2.0.2", "markdown-toc": "1.1.0", + "markdownlint-cli": "^0.3.1", "script-loader": "0.7.0", "webpack": "^2.2.1", "webpack-dev-server": "^2.3.0", diff --git a/ng2-components/package-lock.json b/ng2-components/package-lock.json index 0fe2ac49e0..7f689e861d 100644 --- a/ng2-components/package-lock.json +++ b/ng2-components/package-lock.json @@ -4301,6 +4301,12 @@ "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", "dev": true }, + "linkify-it": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.0.3.tgz", + "integrity": "sha1-2UpGSPmxwXnWT6lykSaL22zpQ08=", + "dev": true + }, "list-item": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/list-item/-/list-item-1.1.1.tgz", @@ -4433,6 +4439,12 @@ "integrity": "sha1-mV7g3BjBtIzJLv+ucaEKq1tIdpg=", "dev": true }, + "lodash.flatten": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.3.0.tgz", + "integrity": "sha1-5exO/ofvxZzlL5F8uovxYGNkac8=", + "dev": true + }, "lodash.isarguments": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz", @@ -4505,6 +4517,12 @@ "integrity": "sha1-0CJTc662Uq3BvILklFM5qEJ1R3M=", "dev": true }, + "lodash.values": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/lodash.values/-/lodash.values-4.2.0.tgz", + "integrity": "sha1-kyYl99LJVLY9uJUlVUjztJ8SDpo=", + "dev": true + }, "lodash.words": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/lodash.words/-/lodash.words-3.2.0.tgz", @@ -4597,6 +4615,12 @@ "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=", "dev": true }, + "markdown-it": { + "version": "8.3.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-8.3.1.tgz", + "integrity": "sha1-L0tiKUjM3Bk9ZvPKLUMSWsSscyM=", + "dev": true + }, "markdown-link": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/markdown-link/-/markdown-link-0.1.1.tgz", @@ -4617,6 +4641,32 @@ } } }, + "markdownlint": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.4.1.tgz", + "integrity": "sha1-NzIMqUSTgCT9a0IbJAGtNJNJWIo=", + "dev": true + }, + "markdownlint-cli": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.3.1.tgz", + "integrity": "sha1-fgWAnyfn9QiGvwWtx9LSW7OwUpM=", + "dev": true, + "dependencies": { + "glob": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.0.6.tgz", + "integrity": "sha1-IRuvr0nlJbjNkyYNFKsTYVKz9Xo=", + "dev": true + }, + "rc": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.1.7.tgz", + "integrity": "sha1-xepWS7B6/5/TpbMukGwdOmWUD+o=", + "dev": true + } + } + }, "material-design-icons": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/material-design-icons/-/material-design-icons-2.2.3.tgz", @@ -4638,6 +4688,12 @@ "resolved": "https://registry.npmjs.org/md-date-time-picker/-/md-date-time-picker-2.2.0.tgz", "integrity": "sha1-aIdfznnbbtEiNevEZ6qTSEX04dY=" }, + "mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", + "dev": true + }, "media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -7519,6 +7575,12 @@ "integrity": "sha1-w8yxbdqgsjFN4DHn5v7onlujRrw=", "dev": true }, + "uc.micro": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.3.tgz", + "integrity": "sha1-ftUNXg+an7ClczeSWfKndFjVAZI=", + "dev": true + }, "uglify-js": { "version": "3.0.22", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.0.22.tgz", diff --git a/ng2-components/package.json b/ng2-components/package.json index e351d9a19d..2b929b2268 100644 --- a/ng2-components/package.json +++ b/ng2-components/package.json @@ -7,14 +7,15 @@ "clean": "rimraf node_modules", "clean-lock": "rimraf package-lock.json", "rimraf": "rimraf", - "build": "npm run webpack -- --config config/webpack.build.js --progress --profile --bail", + "build": "npm run toc && npm run markdownlint && npm run webpack -- --config config/webpack.build.js --progress --profile --bail", "test": "node node_modules/karma/bin/karma start --reporters mocha,coverage --single-run --component .", "test-browser": "node node_modules/karma/bin/karma start karma.conf.js --reporters kjhtml", "coverage": "", "prepublishOnly": "npm run build", "pkg-build": "package-json-merge ng2-alfresco-core/package.json ng2-alfresco-datatable/package.json ng2-activiti-diagrams/package.json ng2-activiti-analytics/package.json ng2-activiti-form/package.json ng2-activiti-tasklist/package.json ng2-activiti-processlist/package.json ng2-alfresco-documentlist/package.json ng2-alfresco-login/package.json ng2-alfresco-search/package.json ng2-alfresco-tag/package.json ng2-alfresco-upload/package.json ng2-alfresco-viewer/package.json ng2-alfresco-webscript/package.json ng2-alfresco-webscript/package.json ng2-alfresco-userinfo/package.json ng2-alfresco-social/package.json package-base.json > package.json", "toc": "markdown-toc -i ng2-alfresco-core/README.md && markdown-toc -i ng2-alfresco-datatable/README.md && markdown-toc -i ng2-activiti-diagrams/README.md && markdown-toc -i ng2-activiti-analytics/README.md && markdown-toc -i ng2-activiti-form/README.md && markdown-toc -i ng2-activiti-tasklist/README.md && markdown-toc -i ng2-activiti-processlist/README.md && markdown-toc -i ng2-alfresco-documentlist/README.md && markdown-toc -i ng2-alfresco-login/README.md && markdown-toc -i ng2-alfresco-search/README.md && markdown-toc -i ng2-alfresco-tag/README.md && markdown-toc -i ng2-alfresco-upload/README.md && markdown-toc -i ng2-alfresco-viewer/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-webscript/README.md && markdown-toc -i ng2-alfresco-userinfo/README.md && markdown-toc -i ng2-alfresco-social/README.md && markdown-toc -i README.md", - "doc": "npm run toc && npm run webpack -- --config config/webpack.doc.js --progress --profile --bail", + "markdownlint": "markdownlint ng2-alfresco-core/README.md && markdownlint ng2-alfresco-datatable/README.md && markdownlint ng2-activiti-diagrams/README.md && markdownlint ng2-activiti-analytics/README.md && markdownlint ng2-activiti-form/README.md && markdownlint ng2-activiti-tasklist/README.md && markdownlint ng2-activiti-processlist/README.md && markdownlint ng2-alfresco-documentlist/README.md && markdownlint ng2-alfresco-login/README.md && markdownlint ng2-alfresco-search/README.md && markdownlint ng2-alfresco-tag/README.md && markdownlint ng2-alfresco-upload/README.md && markdownlint ng2-alfresco-viewer/README.md && markdownlint ng2-alfresco-webscript/README.md && markdownlint ng2-alfresco-webscript/README.md && markdownlint ng2-alfresco-userinfo/README.md && markdownlint ng2-alfresco-social/README.md && markdownlint README.md", + "doc": "npm run markdownlint && npm run toc && npm run webpack -- --config config/webpack.doc.js --progress --profile --bail", "tslint": "", "prepublish": "", "tsc": "", @@ -124,6 +125,8 @@ "karma-systemjs": "^0.16.0", "karma-webpack": "^2.0.2", "loader-utils": "^1.1.0", + "markdown-toc": "1.1.0", + "markdownlint-cli": "^0.3.1", "merge-stream": "1.0.1", "node-sass": "4.5.3", "null-loader": "^0.1.1", @@ -147,8 +150,7 @@ "webpack": "^2.2.1", "webpack-dev-server": "^2.3.0", "webpack-merge": "2.6.1", - "wsrv": "0.1.7", - "markdown-toc": "1.1.0" + "wsrv": "0.1.7" }, "license": "Apache-2.0", "module": "./index.js",