https://github.com/rjz/scrawl-package

Generate npm package reference using scrawl
https://github.com/rjz/scrawl-package

Last synced: 17 days ago
JSON representation

Generate npm package reference using scrawl

• Host: GitHub
• URL: https://github.com/rjz/scrawl-package
• Owner: rjz
• License: other
• Created: 2014-09-09T04:42:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-09T04:43:00.000Z (over 10 years ago)
• Last Synced: 2024-11-22T05:35:40.185Z (about 1 month ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
scrawl-package

===============================================================================

Generate npm package reference using [scrawl][scrawl].

Usage

-------------------------------------------------------------------------------

    $ npm install --save-dev scrawl-package

Then, point it at files in the current directory:

    var packageInfo = require('scrawlProject')({

      match: [

        'index.js',

        'src/**/*.js'

      ]

    });

Options:

  * `match` - a string or array of strings with a glob pattern of files to be

      parsed

  * `dir` - the package directory (optional; defaults to current directory)

  * `transform` - a transformation function to apply to each scrawl comment

      (optional)

Testing

-------------------------------------------------------------------------------

    $ npm test

License

-------------------------------------------------------------------------------

MIT

[scrawl]: https://github.com/caolan/scrawl