Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explicit call out for when process.cwd is set #330

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -310,7 +310,7 @@ be provided:
filename: '', // path of file containing the text being linted

// common to lintText and lintFiles
cwd: '', // current working directory (default: process.cwd())
cwd: '', // current working directory (default: process.cwd() at engine constructor call time)
fix: false, // automatically fix problems
extensions: [], // file extensions to lint (has sane defaults)
globals: [], // custom global variables to declare
Expand Down Expand Up @@ -358,7 +358,7 @@ Lint the provided `files` globs. An `opts` object may be provided:
ignore: [], // file globs to ignore (has sane defaults)

// common to lintText and lintFiles
cwd: '', // current working directory (default: process.cwd())
cwd: '', // current working directory (default: process.cwd() at engine constructor call time)
fix: false, // automatically fix problems
extensions: [], // file extensions to lint (has sane defaults)
globals: [], // custom global variables to declare
Expand All @@ -385,7 +385,7 @@ This is the full set of options accepted by the above APIs. Not all options make
```js
{
ignore: [], // file patterns to ignore (has sane defaults)
cwd: '', // current working directory (default: process.cwd())
cwd: '', // current working directory (default: process.cwd() at engine constructor call time)
filename: '', // path of the file containing the text being linted (optional)
fix: false, // automatically fix problems
globals: [], // custom global variables to declare
Expand Down