Skip to content

Commit

Permalink
docs ~ README revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
rivy committed Feb 14, 2021
1 parent 8b5db5a commit 6d1c676
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ const temp = osPaths.temp();

##### Required Deno permissions

- `--allow-env` ~ requires access to the environment
##### Required Deno permissions

- `--allow-env` (allow access to the process environment variables) <br/> This module/package requires access to various environment variable to determine platform configuration (eg, location of temp and user directories).

## API

Expand Down Expand Up @@ -140,7 +142,7 @@ console.log(osPaths.home());
console.log(osPaths.temp());
```

> Note: for CJS, `require('os-paths')` is supported for backward-compatibility and will execute correctly at run-time. However, this require construction links to the default package type declarations which, though _correct_ for Deno/ESM/TypeScript, are _incorrect_ for CJS. This, then, leads to incorrect analysis of CJS files by static analysis tools such as TypeScript and Intellisense.
> Note: for CJS, `require('os-paths')` is supported for backward-compatibility and will execute correctly at run-time. However, `require('os-paths')` links to the default package type declarations which, though _correct_ for Deno/ESM/TypeScript, are _incorrect_ for CJS. This, then, leads to incorrect analysis of CJS files by static analysis tools such as TypeScript and Intellisense.
>
> Using `require('os-paths/cjs')` is preferred as it associates the proper CJS type declarations and provides correct information to static analysis tools.
Expand Down Expand Up @@ -220,6 +222,7 @@ fix:style fix Prettier formatting issues
help display help
lint check for package code 'lint'
lint:commits check for commit flaws (using `commitlint` and `cspell`)
lint:editorconfig check for EditorConfig format flaws (using `editorconfig-checker`)
lint:lint check for code 'lint' (using `eslint`)
lint:markdown check for markdown errors (using `remark`)
lint:spell check for spelling errors (using `cspell`)
Expand All @@ -232,7 +235,7 @@ show:deps show package dependencies
test test package
test:code test package code
test:types test for type declaration errors (using `tsd`)
update update/prepare for distribution
update update/prepare for distribution [alias: 'dist']
update:changelog update CHANGELOG (using `git changelog ...`)
update:dist update distribution content
```
Expand Down

0 comments on commit 6d1c676

Please sign in to comment.