Research
Recent Trends in Malicious Packages Targeting Discord
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
ember-cli-yuidoc
Advanced tools
Readme
This is an ember-cli addon for generate html documentation from YUIDoc comments in the source code.
If you're using ember-cli > 0.1.5, you can just run ember install ember-cli-yuidoc
and you're done.
If you are using an older version, first install the addon from npm with npm install --save-dev ember-cli-yuidoc
.
Then, you need to add a yuidoc.json
manifest on the root of your project. Run ember g ember-cli-yuidoc
to generate
once with some sensible defaults.
This addon adds a new ember-cli-yuidoc
command to ember-cli to generate the documentation on demand.
Just run ember ember-cli-yuidoc
and your docs will apear in your output directory (/docs
by default).
You probably want to add this folder to the .gitignore
.
This plugin also integrates with the ember server, so you can access your docs from the browser in the /docs
urls.
The documentation will update when you modify your code, as expected.
While this is specially useful if your are editing your documentation, it adds some overhead to your build pipeline,
so this is disabled by default. Run ember serve --docs
to enable it.
This plugin supports the ability to force generate your documentation via the enabledEnvironments
option that may be defined in your yuidoc.json
.
{
"name": "sample-app",
"version": "1.2.3",
"options": {
"enabledEnvironments": ["development", "production"]
}
}
This will generate your documentation when using ember build
ember build --environment=production
ember s
and so on without needing to use --docs
.
The plugin supports coffescript out of the box. In your application's yuidoc.json
you can configure
the syntaxtype
and extension
like this:
{
"name": "sample-app",
"version": "1.2.3",
"options": {
"paths": ["app"],
"exclude": "vendor",
"outdir": "docs",
"syntaxtype": "coffee",
"extension": ".coffee"
}
}
FAQs
Generate documentation of your app/addon from your yuidoc comments
The npm package ember-cli-yuidoc receives a total of 429 weekly downloads. As such, ember-cli-yuidoc popularity was classified as not popular.
We found that ember-cli-yuidoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.