babel-plugin-jsdoc-to-assert

v4.0.0

Babel plugin convert jsdoc to assertion.

NPM

README

GitHub

Website

MIT

Latest version published 2 years ago

    npm install babel-plugin-jsdoc-to-assert

We couldn't find any similar packages Browse all packages

Package Health Score

48 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (323)

Dependents: 10
GitHub Stars: 56
Forks: 3
Contributors: 2

The npm package babel-plugin-jsdoc-to-assert receives a total of 323 downloads a week. As such, we scored babel-plugin-jsdoc-to-assert popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package babel-plugin-jsdoc-to-assert, we found that it has been starred 56 times, and that 10 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.8.0

1.9.0

2.2.1

3.0.4

4.0.0

Indirect Vulnerabilities

1.8.0

1.9.0

2.2.1

3.0.4

4.0.0

License Risks

1.8.0

1.9.0

2.2.1

3.0.4

4.0.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like babel-plugin-jsdoc-to-assert is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test babel-plugin-jsdoc-to-assert

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Merged PR: 7
Open PR: 3
Last Commit: 2 years ago

Further analysis of the maintenance status of babel-plugin-jsdoc-to-assert based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for babel-plugin-jsdoc-to-assert is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No
License: MIT

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like babel-plugin-jsdoc-to-assert is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 2 Direct / 4 Total
Versions: 27
Install Size: 41.6 kB
Dist-tags: 1
# of Files: 15
Maintainers: 1
TS Typings: No

We detected a total of 4 direct & transitive dependencies for babel-plugin-jsdoc-to-assert. See the full dependency tree of babel-plugin-jsdoc-to-assert

babel-plugin-jsdoc-to-assert has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

babel-plugin-jsdoc-to-assert

Babel plugin for jsdoc-to-assert.

Preset version: babel-preset-jsdoc-to-assert: Babel preset for jsdoc-to-assert

This plugin JSDoc(@param and @type) to assertion method for runtime testing.

`@param`

/**
 * @param {number} param - this is a param.
 * @param {string} b - this is a param.
 * @param {string[]} [c] - this is a param.
 */
function myFunc(param, b, c) {
}

/**
 * @param {number} param - this is a param.
 * @param {string} b - this is a param.
 * @param {string[]} [c] - this is a param.
 */
function myFunc(param, b, c) {
  console.assert(typeof param === 'number');
  console.assert(typeof b === 'string');
}

`@type`

/**
 * @type {string}
 */
const value = "s";

/**
 * @type {string}
 */
const value = "s";
console.assert(typeof value === "string");

Installation

npm install babel-plugin-jsdoc-to-assert

Usage

Via .babelrc

{
  "plugins": [
    "jsdoc-to-assert"
  ]
}

In development only:

{
  "presets": [
    "es2015"
  ],
  "env": {
    "development": {
      "plugins": [
        "jsdoc-to-assert"
      ]
    }
  }
}

If build files with NODE_ENV=production, don't convert JSDoc to assert.

"build": "NODE_ENV=production babel src --out-dir lib --source-maps",

Options

checkAtParam: boolean
- Default: true
- Check typing of @param
checkAtType: boolean
- Default: false
- Check typing of @type

FAQ

Q. Try to use this, but throw parsing error:

ERROR in ./src/js/framework/Context.js
Module build failed: SyntaxError: Unterminated string constant (3:16)
    at Parser.pp.raise (/Users/azu/.ghq/github.com/azu/svg-feeling/node_modules/babylon/index.js:1378:13)
    at Parser.readString (/Users/azu/.ghq/github.com/azu/svg-feeling/node_modules/babylon/index.js:5402:49)
    at Parser.getTokenFromCode (/Users/azu/.ghq/github.com/azu/svg-feeling/node_modules/babylon/index.js:52
    ....
 @ ./src/index.js 24:15-48

A. It seem to be a bug of babel-plugin-jsdoc-to-assert. Please file issue with your code 🙇

Q. Why checkAtType is default disable?

It is a problem of babel transform order.

ES2015 -> jsdoc-to-assert cause following problem.

AssertionError: Invalid JSDoc: typeof _this === "string"
+ expected - actual

Tests

npm test

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request 😄

License

MIT