mirror of
https://github.com/Azgaar/Fantasy-Map-Generator.git
synced 2025-12-24 13:01:24 +01:00
merge completed... now to fix all the bugs...
This commit is contained in:
commit
87c4d80fbc
3472 changed files with 466748 additions and 6517 deletions
61
node_modules/eslint-plugin-import/docs/rules/no-deprecated.md
generated
vendored
Normal file
61
node_modules/eslint-plugin-import/docs/rules/no-deprecated.md
generated
vendored
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# `import/no-deprecated`
|
||||
|
||||
Reports use of a deprecated name, as indicated by a JSDoc block with a `@deprecated`
|
||||
tag or TomDoc `Deprecated: ` comment.
|
||||
|
||||
using a JSDoc `@deprecated` tag:
|
||||
|
||||
```js
|
||||
// @file: ./answer.js
|
||||
|
||||
/**
|
||||
* this is what you get when you trust a mouse talk show
|
||||
* @deprecated need to restart the experiment
|
||||
* @returns {Number} nonsense
|
||||
*/
|
||||
export function multiply(six, nine) {
|
||||
return 42
|
||||
}
|
||||
```
|
||||
|
||||
will report as such:
|
||||
|
||||
```js
|
||||
import { multiply } from './answer' // Deprecated: need to restart the experiment
|
||||
|
||||
function whatever(y, z) {
|
||||
return multiply(y, z) // Deprecated: need to restart the experiment
|
||||
}
|
||||
```
|
||||
|
||||
or using the TomDoc equivalent:
|
||||
|
||||
```js
|
||||
// Deprecated: This is what you get when you trust a mouse talk show, need to
|
||||
// restart the experiment.
|
||||
//
|
||||
// Returns a Number nonsense
|
||||
export function multiply(six, nine) {
|
||||
return 42
|
||||
}
|
||||
```
|
||||
|
||||
Only JSDoc is enabled by default. Other documentation styles can be enabled with
|
||||
the `import/docstyle` setting.
|
||||
|
||||
|
||||
```yaml
|
||||
# .eslintrc.yml
|
||||
settings:
|
||||
import/docstyle: ['jsdoc', 'tomdoc']
|
||||
```
|
||||
|
||||
### Worklist
|
||||
|
||||
- [x] report explicit imports on the import node
|
||||
- [x] support namespaces
|
||||
- [x] should bubble up through deep namespaces (#157)
|
||||
- [x] report explicit imports at reference time (at the identifier) similar to namespace
|
||||
- [x] mark module deprecated if file JSDoc has a @deprecated tag?
|
||||
- [ ] don't flag redeclaration of imported, deprecated names
|
||||
- [ ] flag destructuring
|
||||
Loading…
Add table
Add a link
Reference in a new issue