Skip to content

Commit

Permalink
doc: cspell
Browse files Browse the repository at this point in the history
  • Loading branch information
sverweij committed Jul 10, 2022
1 parent 8fc9898 commit 2b62362
Show file tree
Hide file tree
Showing 20 changed files with 54 additions and 58 deletions.
4 changes: 2 additions & 2 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ API

## Versioning

The API follows the same (semantic) versioning rules and rythm as the API does
The API follows the same (semantic) versioning rules and rhythm as the API does

function cruise(pFileAndDirectoryArray, pOptions, pResolveOptions, pTSConfig) {

Expand All @@ -33,7 +33,7 @@ console.dir(cruiseResult.output, { depth: 10 });
You might notice a few things when you do this

- the function ruthlessly cruises _everything_ in `src` and whatever it uses,
recucrsively - even in your `node_modules`. This takes a long time and might
recursively - even in your `node_modules`. This takes a long time and might
not give the information you actually seek. Dependency-cruiser has a bunch of
options to steer what it actually cruises;
[passing cruise options](#Passing cruise options) will get you sorted.
Expand Down
6 changes: 3 additions & 3 deletions doc/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ style src_main_rule_set_normalize_js fill:lime,color:black
Generates a stand-alone html report with:

- a summary with files & dependencies cruised and the number of errors and warnings found
- all rules, ordered by the number of violations (unviolated ones are hidden by default)
- all rules, ordered by the number of violations (un-violated ones are hidden by default)
- a list of all dependency and module violations, ordered by severity, rule name, from module, to module.

```shell
Expand Down Expand Up @@ -1000,7 +1000,7 @@ stay in view when dependency-cruiser is done.

#### none (the default when you don't pass --progress )

Make sure dependency-cruiser doesn't print any feedback. Usefull if you want to
Make sure dependency-cruiser doesn't print any feedback. Useful if you want to
override the progress option configured in a configuration file (currently
an undocumented feature that is subject to change).

Expand Down Expand Up @@ -1095,7 +1095,7 @@ depcruise-fmt -T dot cruise_result.json | dot -T svg > dependency-graph.svg
### filters

You can also use the filters `--focus`, `--include-only` and `--exclude` to peruse
parts of the dependency-graph. This could be useful for chopping up humoungous
parts of the dependency-graph. This could be useful for chopping up humongous
graphs efficiently, or to quickly find the uses of a module:

```sh
Expand Down
16 changes: 8 additions & 8 deletions doc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ When it turns out they aren't yet:
dependency (**recommended!**), install the necessary transpilers there.
- if you're running dependency-cruiser as a global install, install
the necessary transpilers globally as well.
- if you're running dependency-crusier with npx you can pass the necessary
- if you're running dependency-cruiser with npx you can pass the necessary
compiler(s) with the `-p` option. E.g. to get a list of all incoming and
outgoing dependencies of a TypeScript file you could use this:
```
Expand Down Expand Up @@ -67,16 +67,16 @@ If you _do_ want to see these dependencies, do one of these:

</details>

### Q: Some TypeScript dependencies _still_ don't show up (`/// tripple slash directives`)
### Q: Some TypeScript dependencies _still_ don't show up (`/// triple slash directives`)

**_A_**: You're using a version <9.0.0. From version 9.0.0 on tripple slash
**_A_**: You're using a version <9.0.0. From version 9.0.0 on triple slash
directives are recognized without the need for additional configuration. Easiest
is to upgrade to version 9.0.0 or higher.

<details>
<summary>background</summary>

In older versions you needed to add the "tsd" (_tripple slash rective_)
In older versions you needed to add the "tsd" (_triple slash directive_)
module system to the `moduleSystems` array in your dependency-cruiser
configuration - or pass it on the command line (with `--module-systems cjs,ejs,tsd`).

Expand Down Expand Up @@ -344,7 +344,7 @@ export class ReplicateIssueComponent extends React.Component {
```
In [this comment](https://github.com/sverweij/dependency-cruiser/issues/395#issuecomment-730295987)
on the orignal issue [@audunsol](https://github.com/audunsol) offers a few
on the original issue [@audunsol](https://github.com/audunsol) offers a few
ways to work around the issue you might find helpful when you have similar
jsx.
Expand Down Expand Up @@ -383,7 +383,7 @@ manually.
For `.svelte` single file components it uses the `svelte` (version 3.x)
- which will be in your module dependencies if you're developing with Svelte.
- because of how svelt works, all `.svelte` files depend on `"svelte/internal"`.
- because of how svelte works, all `.svelte` files depend on `"svelte/internal"`.
If that turns out to be too noisy, you can configure dependency-cruiser to
ignore it (either in the config file or with a command-line param)
Expand Down Expand Up @@ -471,7 +471,7 @@ influence performance, loosely in order of impact:
to _only_ set a `path` for that (typically `node_modules`).
- If your codebase can be compiled successfully with `swc` setting the parser
to `swc` will help speed up things a bit (although not as dramatically as
you'd dexpect).
you'd expect).
- By default some rules dependency-cruiser ships with include regular
expressions that will not be entirely applicable to your code base (do you
still have files ending in `.coffee`?). It’s probably not going to make a
Expand Down Expand Up @@ -615,7 +615,7 @@ For reporters that should come shipped with dependency-cruiser do this:
- In `test/report` add unit tests that prove your reporter does what it
intends.
### Q: How do I add support for my favourite alt-js language?
### Q: How do I add support for my favorite alt-js language?
**A**: Ask me nicely or make a PR.
Expand Down
14 changes: 7 additions & 7 deletions doc/options-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ Sample
}
```

You can do it even more minimalistically like so (in which case dependency-cruiser will
You can do it even more minimalistic like so (in which case dependency-cruiser will
assume the fileName to be `tsconfig.json`)

```json
Expand Down Expand Up @@ -568,7 +568,7 @@ babelConfig - dependency-cruiser will sort it out for you.
for regular features might be considered breaking (think of more precise
module system determination).
- :construction: The current implementation of babel support is robust, but can be more
efficient. It's on the [roadmap](https://github.com/sverweij/dependency-cruiser/projects/1#card-39192574),
efficient. It's on the [road map](https://github.com/sverweij/dependency-cruiser/projects/1#card-39192574),
but as it's not entirely trivial it may take some time. The implementation
will be feature switched to guarantee stability.

Expand Down Expand Up @@ -1187,7 +1187,7 @@ module.exports = {
## text
When you emit a text report you might want to see more clearly which modules you
'focussed' with the `focus` option and which are callers/ callees. In order to do
'focussed' with the `focus` option and which are callers/ called. In order to do
so you can pass an option that highlights focused modules (currently by
<u>underlining</u> the focused modules).
Expand Down Expand Up @@ -1277,7 +1277,7 @@ The first step dependency-cruiser takes is to scan files and folders matching
the arguments you passed it for files it can parse - typically TypeScript or
JavaScript sources. Only in a next step it considers other file types, like
when you include a picture from a `.jsx`. This approach means dependency-cruiser
only finds these file types when they're reachable from parseable file types.
only finds these file types when they're reachable from parsable file types.
If you want to run orphan or reachability rules against these file types, however
you might want include them in the first scan already. To do so you can pass
Expand Down Expand Up @@ -1336,7 +1336,7 @@ However, if you want it to scan less you can specify so with the extensions
attribute. E.g. when you're 100% sure you _only_ have typescript & json and
nothing else you can pass `['.ts', '.json']` - which can lead to performance gains
on systems with slow i/o (like ms-windows), especially when your tsconfig
contains paths/ aliasses.
contains paths/ aliases.
#### cachedInputFileSystem - `cacheDuration`
Expand All @@ -1350,7 +1350,7 @@ resolutions in memory.
With `cacheDuration` you can tweak the number of milliseconds
[enhanced-resolve](https://github.com/webpack/enhanced-resolve)'s cached
file system should use for cache duration. Typicially you won't have to touch
file system should use for cache duration. Typically you won't have to touch
this - the default works well for repos up to 5000 modules/ 20000 dependencies,
and likely for numbers above as well. If you experience memory problems on a
(humongous) repository you can use the cacheDuration attribute to tame
Expand Down Expand Up @@ -1394,6 +1394,6 @@ as the primary parser: the `acorn` one, which handles all things javascript
typescript; microsoft's `tsc` or the faster and smaller (but slightly less
feature rich) `swc`.
`swc` and `tsc` only work when the compilers (respectivley `@core/swc` and
`swc` and `tsc` only work when the compilers (respectively `@core/swc` and
`typescript`) are installed in the same spot as dependency-cruiser is. They're
not bundled with dependency-cruiser.
6 changes: 3 additions & 3 deletions doc/real-world-samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ node ./bin/dependency-cruise.js bin src --config --output-type ddot | \
[![dependency cruiser's dependency graph](real-world-samples/dependency-cruiser-without-node_modules.svg)](https://sverweij.github.io/dependency-cruiser/dependency-cruiser-dependency-graph.html)

<details>
<summary>howto</summary>
<summary>how to</summary>

To generate this yourself do this in the root of the dependency-cruiser repo:

Expand Down Expand Up @@ -254,14 +254,14 @@ interpreter for writing nice state diagrams. Click for a slightly
more interactive version. As you can see this graph does not group modules
from same folders into clusters. Instead it uses only colors for 'grouping'
and notes the folder name in the nodes. It's what the ['flat'](https://github.com/sverweij/dependency-cruiser/blob/develop/doc/cli.md#flat-fdot) graph reporter
does for you. See the howto foldout below to see how to reproduce it.
does for you. See the _how to_ foldout below to see how to reproduce it.

(For this too: click for a slightly more interactive version)

[![state-machine-cat without external dependencies](https://state-machine-cat.js.org/dependency-cruiser-graph-flat-dot.svg)](https://state-machine-cat.js.org/dependency-cruiser-graph-flat-dot.html)

<details>
<summary>howto</summary>
<summary>how to</summary>

```sh
git clone git@github.com:sverweij/state-machine-cat.git
Expand Down
2 changes: 1 addition & 1 deletion doc/rules-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ _did not_ save it to package.json. Or you already had it in your devDependencies
and started using it in a production source.

To save you from embarrassing moments like this, you can make rules with the
`dependencyTypes` restrction. E.g. to prevent you accidentally depend on a
`dependencyTypes` restriction. E.g. to prevent you accidentally depend on a
`devDependency` from anything in `src` add this to your
.dependency-cruiser.js's "forbidden" section:

Expand Down
2 changes: 1 addition & 1 deletion doc/rules-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ forbidden: [
```

As you see this rule uses the $1 and $2 variables. These match the parts in the
from.path between brackets. In the regular expession world this is called
from.path between brackets. In the regular expression world this is called
'group matching'. Read more about this in the [rules reference](./rules-reference.md#group-matching)

Et voilá:
Expand Down
8 changes: 4 additions & 4 deletions src/cli/init-config/config.js.template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ module.exports = {
"This is an orphan module - it's likely not used (anymore?). Either use it or " +
"remove it. If it's logical this module is an orphan (i.e. it's a config file), " +
"add an exception for it in your dependency-cruiser configuration. By default " +
"this rule does not scrutinize dotfiles (e.g. .eslintrc.js), TypeScript declaration " +
"this rule does not scrutinize dot-files (e.g. .eslintrc.js), TypeScript declaration " +
"files (.d.ts), tsconfig.json and some of the babel and webpack configs.",
severity: 'warn',
from: {
Expand Down Expand Up @@ -138,7 +138,7 @@ module.exports = {
{
name: 'no-duplicate-dep-types',
comment:
"Likeley this module depends on an external ('npm') package that occurs more than once " +
"Likely this module depends on an external ('npm') package that occurs more than once " +
"in your package.json i.e. bot as a devDependencies and in dependencies. This will cause " +
"maintenance problems later on.",
severity: 'warn',
Expand Down Expand Up @@ -208,7 +208,7 @@ module.exports = {
"This module depends on an npm package that is declared as an optional dependency " +
"in your package.json. As this makes sense in limited situations only, it's flagged here. " +
"If you're using an optional dependency here by design - add an exception to your" +
"depdency-cruiser configuration.",
"dependency-cruiser configuration.",
from: {},
to: {
dependencyTypes: [
Expand Down Expand Up @@ -365,7 +365,7 @@ module.exports = {

/* List of strings you have in use in addition to cjs/ es6 requires
& imports to declare module dependencies. Use this e.g. if you've
redeclared require, use a require-wrapper or use window.require as
re-declared require, use a require-wrapper or use window.require as
a hack.
*/
// exoticRequireStrings: [],
Expand Down
2 changes: 1 addition & 1 deletion src/cli/init-config/config.js.template.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions tools/schema/dependencies.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export default {
description:
"the type of inclusion - local, core, unknown (= we honestly don't " +
"know), undetermined (= we didn't bother determining it) or one of " +
"the npm dependencies defined in a package.jsom ('npm' for 'dependencies', " +
"the npm dependencies defined in a package.json ('npm' for 'dependencies', " +
"'npm-dev', 'npm-optional', 'npm-peer', 'npm-no-pkg' for development, " +
"optional, peer dependencies and dependencies in node_modules but not " +
"in package.json respectively)",
Expand Down Expand Up @@ -109,7 +109,7 @@ export default {
couldNotResolve: {
type: "boolean",
description:
"'true' if dependency-cruiser could not resulve the module name in " +
"'true' if dependency-cruiser could not resolve the module name in " +
"the source code to a file name or core module. 'false' in all other " +
"cases.",
},
Expand Down
2 changes: 1 addition & 1 deletion tools/schema/folders.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export default {
instability: {
type: "number",
description:
"the instability of the dependency (denormalized - this is " +
"the instability of the dependency (de-normalized - this is " +
"a duplicate of the one found in the instability of the " +
"folder with the same name)",
},
Expand Down
4 changes: 2 additions & 2 deletions tools/schema/modules.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export default {
description:
"the type of inclusion - local, core, unknown (= we honestly don't " +
"know), undetermined (= we didn't bother determining it) or one of " +
"the npm dependencies defined in a package.jsom ('npm' for 'depenencies', " +
"the npm dependencies defined in a package.json ('npm' for 'dependencies', " +
"'npm-dev', 'npm-optional', 'npm-peer', 'npm-no-pkg' for development, " +
"optional, peer dependencies and dependencies in node_modules but not " +
"in package.json respectively)",
Expand Down Expand Up @@ -175,7 +175,7 @@ export default {
via: {
type: "array",
description:
"The path along wich the 'to' module is reachable from this one.",
"The path along which the 'to' module is reachable from this one.",
items: { type: "string" },
},
},
Expand Down
8 changes: 4 additions & 4 deletions tools/schema/options.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export default {
forceDeriveDependents: {
type: "boolean",
description:
"When true includes denormalized dependents in the cruise-result, even " +
"When true includes de-normalized dependents in the cruise-result, even " +
"though there's no rule in the rule set that requires them. Defaults to false.",
},
webpackConfig: {
Expand Down Expand Up @@ -231,7 +231,7 @@ export default {
"extensions attribute. E.g. when you're 100% sure you _only_ have " +
"typescript & json and nothing else you can pass ['.ts', '.json'] " +
"- which can lead to performance gains on systems with slow i/o " +
"(like ms-windows), especially when your tsconfig contains paths/ aliasses.",
"(like ms-windows), especially when your tsconfig contains paths/ aliases.",
items: {
type: "string",
},
Expand All @@ -250,7 +250,7 @@ export default {
maximum: 1800000,
description:
"The number of milliseconds [enhanced-resolve](webpack/enhanced-resolve)'s " +
"cached file system should use for cache duration. Typicially you won't " +
"cached file system should use for cache duration. Typically you won't " +
"have to touch this - the default works well for repos up to 5000 modules/ " +
"20000 dependencies, and likely for numbers above as well. " +
"If you experience memory problems on a (humongous) repository you can " +
Expand Down Expand Up @@ -290,7 +290,7 @@ export default {
type: "array",
description:
"List of strings you have in use in addition to cjs/ es6 requires & " +
"imports to declare module dependencies. Use this e.g. if you've redeclared " +
"imports to declare module dependencies. Use this e.g. if you've re-declared " +
"require (`const want = require`), use a require-wrapper (like semver-try-require) " +
"or use window.require as a hack to workaround something",
items: {
Expand Down
6 changes: 3 additions & 3 deletions tools/schema/restrictions.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ export default {
licenseNot: {
description:
"Whether or not to match modules that were NOT released under one of " +
'the mentioned licenses. E.g. to flag everyting non MIT use "MIT" here',
'the mentioned licenses. E.g. to flag everything non MIT use "MIT" here',
$ref: "#/definitions/REAsStringsType",
},
via: {
Expand All @@ -147,7 +147,7 @@ export default {
description:
"For circular dependencies - whether or not to match cycles that include " +
"exclusively modules with this regular expression. This is different from " +
"the regular via that already mathces when only some of the modules in the " +
"the regular via that already matches when only some of the modules in the " +
"cycle satisfy the regular expression",
$ref: "#/definitions/REAsStringsType",
},
Expand Down Expand Up @@ -211,7 +211,7 @@ export default {
},
DependentsFromRestrictionType: {
description:
"Criteria the dependents of the module should adehere to be caught by this rule " +
"Criteria the dependents of the module should adhere to be caught by this rule " +
"rule. Leave it empty if you want any dependent to be matched.",
required: [],
type: "object",
Expand Down
Loading

0 comments on commit 2b62362

Please sign in to comment.