eslint-plugin-mobx 0.0.0 → 0.0.5

package/prettier.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  trailingComma: 'es5',
-  semi: false,
-  singleQuote: true,
-  jsxSingleQuote: true,
-  arrowParens: 'always',
-}

package/todo-rules.md

@@ -1,115 +0,0 @@
-https://mobx.js.org/refguide/api.html#configure
-
-### mobx/array-buffer: number
-
-Increases the default created size of observable arrays to arrayBuffer, if the maximum size isn't yet there.
-
-Observable arrays lazily create getters on members of ObservableArray.prototype starting at 0. This will create the members from 0 to arrayBuffer if they don't yet exist. Use arrayBuffer if you know you'll have a common minimum array size and don't want to risk first creating those getters in hot code paths. See also observable.
-
-### mobx/computed-requires-reaction: boolean
-
-Forbids the access of any unobserved computed value. Use this if you want to check whether you are using computed properties without a reactive context.
-
-```
-configure({ computedRequiresReaction: true })
-```
-
-### mobx/observable-requires-reaction: boolean
-
-Warns about any unobserved observable access. Use this if you want to check whether you are using observables without a reactive context (eg not inside an autorun, action, or react component without observer wrapping).
-
-```
-configure({ observableRequiresReaction: true })
-```
-
-### mobx/reaction-requires-observable: boolean
-
-Warns when a reaction (eg autorun) is created without any observable access. Use this to check whether you are unneededly wrapping react components with observer, or to find possible related bugs.
-
-```
-configure({ reactionRequiresObservable: true })
-```
-
-### mobx/computed-configurable: boolean
-
-Allows overwriting computed values. This is useful for testing purposes only. Don't enable this on production as it can cause memory-leaks.
-
-```
-configure({ computedConfigurable: true })
-```
-
-### mobx/disable-error-boundaries: boolean
-
-By default, MobX will catch and rethrow exceptions happening in your code to make sure that a reaction in one exception does not prevent the scheduled execution of other, possibly unrelated, reactions. This means exceptions are not propagated back to the original causing code and therefore you won't be able to catch them using try/catch.
-
-There may be times when you want to catch those errors, for example when unit testing your reactions. You can disable this behaviour using disableErrorBoundaries.
-
-```
-configure({ disableErrorBoundaries: true })
-```
-
-Please note that MobX won't recover from errors when using this configuration. For that reason, you may need to use \_resetGlobalState after each exception. Example:
-
-```
-configure({ disableErrorBoundaries: true })
-
-test("Throw if age is negative", () => {
-    expect(() => {
-        const age = observable.box(10)
-        autorun(() => {
-            if (age.get() < 0) throw new Error("Age should not be negative")
-        })
-        age.set(-1)
-    }).toThrow()
-    _resetGlobalState() // Needed after each exception
-})
-```
-
-> Prior to MobX 4, \_resetGlobalState was extras.resetGlobalState.
-
-### mobx/enforce-actions
-
-Also known as "strict mode". In strict mode, it is not allowed to change any state outside of an action. Acceputed vales:
-
-`"never"` (default): State can be modified from anywhere
-`"observed"`: All state that is observed somewhere needs to be changed through actions. This is the recommended strictness mode in non-trivial applications.
-`"always"`: State always needs be updated (which in practice also includes creation) in actions.
-
-### mobx/isolate-global-state: boolean
-
-Isolates the global state of MobX, when there are multiple instances of MobX in the same environment. This is useful when you have an encapsulated library that is using MobX, living in the same page as the app that is using MobX. The reactivity inside the library will remain self-contained when you call configure({isolateGlobalState: true}) inside the library.
-
-Without this options, if multiple MobX instances are active, the internal state will be shared. The benefit is that observables from both instances work together, the downside is that the MobX versions have to match.
-
-```
-configure({ isolateGlobalState: true })
-```
-
-### mobx/reaction-scheduler: (f: () => void) => void
-
-Sets a new function that executes all MobX reactions. By default reactionScheduler just runs the f reaction without any other behavior. This can be useful for basic debugging, or slowing down reactions to visualize application updates.
-
-```
-configure({
-    reactionScheduler: (f): void => {
-        console.log("Running an event after a delay:", f)
-        setTimeout(f, 100)
-    }
-})
-```
-
-### mobx/prefer-flow
-
-https://mobx.js.org/refguide/api.html#flow
-
-### mobx/prefer-run-in-action
-
-### mobx/enforce-action-name
-
-```
-action('name', () => {})()
-```
-
-### mobx/sort-class-params
-
-Enforces observable, action, computed sorting