# ember-docs [![Build Status](https://travis-ci.org/CondeNast-Copilot/ember-docs.svg?branch=latest)](https://travis-ci.org/CondeNast-Copilot/ember-docs) [![Maintainability](https://api.codeclimate.com/v1/badges/5967ca0844ee0a653d81/maintainability)](https://codeclimate.com/github/CondeNast-Copilot/ember-docs/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/5967ca0844ee0a653d81/test_coverage)](https://codeclimate.com/github/CondeNast-Copilot/ember-docs/test_coverage)

:warning: This library is in progress and shouldn't be used quite yet. :warning:

ember-docs is a library to generate better documentation for Ember applications, using Ember's strong conventions to enhance JSDoc.

## Installation

```js
npm install @condenast/ember-docs
```

## Why?

Ember has strong conventions, so we wanted to bring those conventions to writing documentation for Ember apps and Ember addons. Since the conventions are so strong, we can remove a lot of requirements of documentation engines and pull the information directly from code.

## :sparkles: Magic :sparkles:

:point_right: No need to name files or define access on them.

> `app/helpers/equals.js` is automatically detected as a public helper named `equals` because it's in the correct spot for an Ember helper.

> `app/helpers/-in-element.js` is detected as a private helper because of the preceding `-`.

:point_right: No need to duplicate parameter structure in components & helpers.

> Positional and named parameters are pulled from component and helper definitions and provided for you.

:point_right: Defaults are pulled from code

> Default parameters are pulled from the code so you don't need to to define them twice. (Yes, you can override this)

Creates documentation from Ember apps / addons. 

@condenast/ember-docs

Creates documentation from Ember apps / addons

abarredo

abolishme

abra

abraham

adrianharwood

agaerig

ahilario

ajadoona

alexander_caba

alexli

alexlrobertson

aliebster

allanparsons

allison

almostagile

alucking

ambikacastle

amelnikova

amishapatel

ananias

angelurena

angrymongoose

annabarr

annamaybank

arauner

ashheskes

asiegler

bbui

benrkarl

bgupta

bigmediumjosh

bigzed

biku

bingeboy

bitboxx

blaine

blurei

bmilton

bmullan91

bodyslam

brad_frost

brettconde

brian_mathews

brokentone

bryanwagman

bwong

candrenast

carasconde

cashmore1990

ccruz2886

cdoo

cfeucht

chadwickthebold

chancancode

chirschorn

cirpo

clavery63

clebron

clementbresson

cloudytomboy

cn_jenkins

cnantoninor

cng0mc1a26x1

cnid_engineering

codingdesigner

codingmatty

coh516

colin_le

condenastadmin

copilot-robot

crccheck

crmartin

cry4dawn_2000

ctruelson

cwoldt

dadeg

damianberesford

danestuckel

danhaller

daniel

daniel-hayes

dario.goutto

dariusk

daveawb-cn

dcolucci

derrickatcn

dharden

dickson-conde

diffcunha

dkorenblyum

dlopezh

dolufemi

drosenbaum

dwschrashun

ecudahy

eespinal

ekelak

erichamilton

ernestohegi

evanjhopkins

ember-docs

An ambiguous license classifier was found.

What is an ambiguous license classifier?

Ambiguous License Classifier

Source files are encoded using a non-standard text encoding.

What is bad text encoding?

Bad text encoding

Package version is not a valid semantic version (semver).

What is bad semver?

Bad semver

Package has dependencies with an invalid semantic version. This could be a sign of beta, low quality, or unmaintained dependencies.

What is bad dependency semver?

Bad dependency semver

Source files contain bidirectional unicode control characters. This could indicate a Trojan source supply chain attack. See: trojansource.codes for more information.

What are bidirectional unicode control characters?

Bidirectional unicode control characters

This package has multiple bin scripts with the same name. This can cause non-deterministic behavior when installing or could be a sign of a supply chain attack.

What is bin script confusion?

Bin script confusion

This Chrome extension includes content scripts that execute JavaScript on specified websites.

What are Chrome extension content scripts?

Chrome: Content Script

This Chrome extension requests host permissions to access specific websites or domains.

What are Chrome extension host permissions?

Chrome: Host Permission

This Chrome extension requests permissions to access browser APIs, user data, or system features.

What are Chrome extension permissions?

Chrome: Permission

This Chrome extension requests wildcard host permissions that grant broad access to websites.

What are Chrome extension wildcard host permissions?

Chrome: Wildcard Host Permission

Semantic versions published out of chronological order.

What is a chronological version anomaly?

Chronological version anomaly

Project maintainer's SSH key has been compromised.

What is a compromised SSH key?

Compromised SSH key

What do I need to know about license files?

Copyleft License

Contains a Critical Common Vulnerability and Exposure (CVE).

What is a critical CVE?

Title

Critical CVE

Contains a high severity Common Vulnerability and Exposure (CVE).

What is a CVE?

High CVE

Uses debug, reflection and dynamic code execution features.

What is debug access?

Debug access

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

What is a deprecated package?

Deprecated

Contains a known deprecated SPDX license exception.

What is a deprecated SPDX exception?

Deprecated SPDX exception

License is deprecated which may have legal implications regarding the package's use.

What is a deprecated license?

Deprecated license

Package name is similar to other popular packages and may not be the package you want.

What is a typosquat?

Possible typosquat attack

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

What is dynamic require?

Dynamic require

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

What is an empty package?

Empty package

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

What is environment variable access?

Environment variable access

Something was found which is explicitly marked as unlicensed.

Explicitly Unlicensed Item

Package optionally loads a dependency which is not specified within any of the package.json dependency fields. It may inadvertently be importing dependencies specified by other packages.

What are extraneous dependencies?

Name

Extraneous dependency

Contains a dependency which resolves to a file. This can obfuscate analysis and serves no useful purpose.

What are file dependencies?

File dependency

Accesses the file system, and could potentially read sensitive data.

What is filesystem access?

Filesystem access

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

What are wildcard dependencies?

Wildcard dependency

Generic ad-hoc alert, uploaded by user or produced by system diagnostics

Alert title

Generic alert

An input argument to this GitHub Action is being exported as an environment variable. If a user of this action passes untrusted input, it could be used in an insecure manner by subsequent workflow steps.

What are GitHub Actions taint flows?

GitHub Actions: Input argument exported as environment variable

An input argument to this GitHub Action is being passed back as an output. If a user of this action passes untrusted input, it could be used in an insecure manner by consuming workflows.

GitHub Actions: Input argument passed back as output

An input argument to this GitHub Action flows into a dangerous sink (such as shell command execution). This could allow a malicious user to inject commands or exploit the action.

GitHub Actions: Input argument flows to dangerous sink

A GitHub context variable (such as issue title, PR description, or comment body) is being exported as an environment variable. These context values are user-controlled and could be exploited by subsequent workflow steps.

GitHub Actions: GitHub context variable exported as environment variable

@condenast/ember-docs

Installation

Why?

:sparkles: Magic :sparkles:

Related posts

Socket for Jira Is Now Available

Socket Named Top Sales Organization by RepVue