broccoli-sassdoc - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "broccoli-sassdoc",
   "title": "Broccoli SassDoc",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "SassDoc compiler for Broccoli",
@@ -6,0 +6,0 @@ "keywords": [

README.md

 # broccoli-sassdoc [![npm version](http://img.shields.io/npm/v/broccoli-sassdoc.svg?style=flat)](https://www.npmjs.org/package/broccoli-sassdoc) [![Build Status: Linux](http://img.shields.io/travis/SassDoc/broccoli-sassdoc.svg?style=flat)](https://travis-ci.org/SassDoc/broccoli-sassdoc?branch=master)
 
-> [SassDoc](https://github.com/SassDoc/sassdoc) compiler for Broccoli.
+> [SassDoc] compiler for [Broccoli].
 
+[SassDoc]: https://github.com/SassDoc/sassdoc
+[Broccoli]: https://github.com/broccolijs/broccoli
 
-## Installation
+## Documentation
 
-```sh
-npm install --save-dev broccoli-sassdoc
-```
+Refers to the SassDoc Broccoli task [main documentation](http://sassdoc.com/broccoli/).
 
 
-## Usage
-
-```js
-var sassdoc = require('broccoli-sassdoc');
-
-var tree = sassdoc('path/to/sass', options);
-```
-
-
-## Options
-
-Any specified option will be passed through directly to SassDoc, thus you can specify any option that SassDoc supports.
-See the [SassDoc documentation](https://github.com/SassDoc/sassdoc/wiki/Customising-the-View) for a list of supported options.
-
-
-#### verbose
-
-Type: `Boolean`  
-Default: `false`
-
-Whether to enable SassDoc own logger or not.
-
-
-#### config
-
-Type: `String`  
-Default: `null`
-
-Path to a view configuration file.
-
-
-#### display.access
-
-Type: `Array`  
-Default: `['public', 'private']`
-
-Access levels that should be displayed.
-
-
-#### display.alias
-
-Type: `Boolean`  
-Default: `false`
-
-Enable/disable display of alias items.
-
-
-#### display.watermark
-
-Type: `Boolean`  
-Default: `true`
-
-Enable/disable display of SassDoc watermark in footer.
-
-
-#### package
-
-Type: `String | Object`  
-Default: `null`
-
-Pass your project informations to the generated view.
-Either a path to your `package.json` or an object.
-
-Following keys will be looked for:
-`title`
-`name`
-`version`
-`license`
-`homepage`
-`description`
-
-
-#### theme <span style="font-size: .7em">*(since sassdoc@1.2.0)*</span>
-
-
-Type: `String`  
-Default: `'default'`
-
-Name of a custom theme, either a published package or a local one.
-Check the [doc](https://github.com/SassDoc/sassdoc/wiki/Using-Your-Own-Theme) for more infos.
-
-
-#### groups <span style="font-size: .7em">*(since sassdoc@1.2.0)*</span>
-
-Type: `Object`  
-Default: `{ 'undefined': 'Ungrouped' }`
-
-Give friendly names to your groups, if any.
-Check the [doc](https://github.com/SassDoc/sassdoc-filter#group-name) for more infos.
-
-
-#### basePath <span style="font-size: .7em">*(since sassdoc@1.2.0)*</span>
-
-Type: `String`  
-Default: `null`
-
-An URL or a path which will be transformed in a link to the source file.
-Check the [doc](https://github.com/SassDoc/sassdoc/wiki/Customising-the-View) for more infos.
-
-
-_**Heads up**: If a config file is passed and found, its options will prevail over defauts.
-Additionnal options passed to the grunt task, will complement it but not override it.
-You should really manage your options in one place._
-
-
-### Config examples
-
-```js
-// Bare minimum, using defaults.
-var tree = sassdoc('path/to/sass');
-```
-
-```js
-// Example with external view configuration file.
-var tree = sassdoc('path/to/sass', {
-    verbose: true,
-    config: 'path/to/view.json'
-});
-```
-
-```js
-// Example with passed in options.
-var tree = sassdoc('path/to/sass', {
-    verbose: true,
-    display: {
-      access: ['public', 'private'],
-      alias: true,
-      watermark: true
-    },
-    package: './package.json'
-});
-```
-
-
 ## Authors
@@ -148,0 +14,0 @@

New alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

3270

decreased by-60.98%

Lines of code

0

decreased by-100%

Number of lines in readme file

21

decreased by-86.45%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes