Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@agrarium/plugin-bemjsd
Advanced tools
Agrarium plugin for BEM JSDoc. More info about JSD parser here.
npm i agrarium
Or use it standalone:
npm i @agrarium/plugin-bemjsd
In your .agrarium.js
file:
const { PluginBemJSD } = require('agrarium');
module.exports = {
src: ['./src/components'],
plugins: [
new PluginBemJSD()
]
};
console.log(chunk.data)
{
bemjsd: [{
jsd: {
"jsdocType": "root",
"modules": [
{
"jsdocType": "module",
"name": "button",
"exports": {
"jsdocType": "class",
"name": "button",
"proto": {
"jsdocType": "type",
"jsType": "Object",
"props": [
{
"key": "getText",
"val": {
"jsdocType": "type",
"jsType": "Function",
"returns": {
"jsdocType": "returns",
"description": "",
"jsType": "String"
},
"description": "Returns text of the button"
}
},
{
"key": "setText",
"val": {
"jsdocType": "type",
"jsType": "Function",
"params": [
{
"jsdocType": "param",
"name": "text",
"description": "",
"jsType": "String"
}
],
"returns": {
"jsdocType": "returns",
"description": "this",
"jsType": "button"
},
"description": "Sets text to the button"
}
}
]
},
"augments": {
"jsdocType": "type",
"jsType": "control"
},
"bem": {
"jsdocType": "bem",
"block": "button"
}
},
"classes": {
"button": {
"jsdocType": "class",
"name": "button",
"proto": {
"jsdocType": "type",
"jsType": "Object",
"props": [
{
"key": "getText",
"val": {
"jsdocType": "type",
"jsType": "Function",
"returns": {
"jsdocType": "returns",
"description": "",
"jsType": "String"
},
"description": "Returns text of the button"
}
},
{
"key": "setText",
"val": {
"jsdocType": "type",
"jsType": "Function",
"params": [
{
"jsdocType": "param",
"name": "text",
"description": "",
"jsType": "String"
}
],
"returns": {
"jsdocType": "returns",
"description": "this",
"jsType": "button"
},
"description": "Sets text to the button"
}
}
]
},
"augments": {
"jsdocType": "type",
"jsType": "control"
},
"bem": {
"jsdocType": "bem",
"block": "button"
}
}
}
}
]
}
}]
}
FAQs
Agrarium plugin for BEM JSDoc
The npm package @agrarium/plugin-bemjsd receives a total of 1 weekly downloads. As such, @agrarium/plugin-bemjsd popularity was classified as not popular.
We found that @agrarium/plugin-bemjsd demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.