Skip to content

Commit

Permalink
updates to readme and dictionary
Browse files Browse the repository at this point in the history
  • Loading branch information
maxwondercorn committed Dec 3, 2018
1 parent 70884b2 commit 4ff1dba
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ To use the dictionary, add it to `.remarkrc.js` file with the appropriate config
const unified = require("unified");
const engUs = require("dictionary-en-us");
const dicEmber = require("ember-dictionary")
const read = require('fs').readFileSync;

exports.plugins = [
[
Expand All @@ -37,7 +38,7 @@ exports.plugins = [
{
dictionary: engUs,
// dictionary: dicEmber,
// personal: require("./dictionary/local.dic").join('\n')
personal: read("./.local.dic")
}
],
]
Expand All @@ -54,7 +55,7 @@ exports.plugins = [

The dictionary should contain names, terms, variables, and/or properties that are common to the Ember ecosystem and community. Examples would include `addon`, `rootURL`, `LTS` and `codemod`.

Technical jargon such as `SemVar`, `QUnit`, and `minification` would also be included in the dictionary.
Technical jargon such as `SemVar`, `QUnit`, and `minification` should also be included in the dictionary.

Generally, packages or addon names would not be included in the dictionary. The exception would be any core package, such as `ember-cli-dependency-checker` would be included. Any package or addon in the Ember namespace would be in the dictionary,.

Expand Down
14 changes: 13 additions & 1 deletion index.dic
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ LTS
README
UI
Async
Config
DevTools
ESLint
Ember
Expand All @@ -21,19 +22,25 @@ Testem
Vim
VSCode
addon/S
addAddonToProject
addBowerPackageToProjec
addPackageToProject
autoRun
bugfix/S
codebase
codemod
codemods
config
configPath
dasherized
deprecation/S
ember-try
engineering/A
http
in-depth
in-repo
lifecycle
linter
localhost:4200
minifyCSS
minifyJS
Expand All @@ -43,14 +50,19 @@ namespace/S
npm
outputPaths
performant
podModulePrefix
precompiler/S
pewprocessed
preprocessor/S
pewprocessed
rootURL
sourcemap/S
storeConfigInMeta
stylesheet/S
subdirectories
subdirectory
symlink/S
uglify
uglification
vendorFile/S
vendorFile/S
webpack
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const util = require('util');
const read = require('fs').readFile;
const readFile = util.promisify(read);
const path = require('path');
const util = require('util');

module.exports = load;

Expand Down

0 comments on commit 4ff1dba

Please sign in to comment.