# jsskel

**Repository Path**: mirrors_mapbox/jsskel

## Basic Information

- **Project Name**: jsskel
- **Description**: Skeleton of a JavaScript package
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

A skeleton JavaScript project using a common toolset

## Features

* [eslint](http://eslint.org/) is used to keep code clean
* [tap](https://www.npmjs.com/package/tap) is used for testing and code coverage
* [retire](https://blog.liftsecurity.io/2014/11/19/bower-components-with-known-vulnerabilities) is used to check for vulnerable modules
* [documentation.js](http://documentation.js.org/) is used to generate documentation

## Usage

```
git clone https://github.com/mapbox/jsskel.git
mv jsskel <project name>
cd <project name>
npm init
# Fill in the details
git remote set-url origin <your project URL>
```

The following npm scripts are provided by package.json:

* `npm run retire`: Check for vulnerable modules (run automatically as part of `npm test`)
* `npm run lint`: Run linting (run automatically as part of `npm test`)
* `npm run docs-page`: Generate documentation from JSDoc comments. You should check in the resulting output, which is set up assuming you'll be publishing to GitHub pages.
* `npm run docs-readme`: Generate documentation from JSDoc comments, and inject them into the README (this file), replacing the `## API` section.

Feel free to adjust any of the defaults to taste after creating a new module.

## API

Document the module's API here