sourcery-nightly 1.0.10b1__py2.py3-none-manylinux1_x86_64.whl → 1.0.10b6__py2.py3-none-manylinux1_x86_64.whl

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/assignment-operator.yaml

@@ -1,6 +1,10 @@
 rules:
 - id: assignment-operator
   description: Replace assignment with assignment operator
+  explanation: |
+    The augmented assignment operators, such as `+=` are a more streamlined and easy to understand way
+    to add values. Using them removes a little bit of repetition and makes the code slightly easier to
+    understand.
   language: javascript
   tags:
   - default

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/avoid-infinite-loops.yaml

@@ -102,3 +102,10 @@ rules:
           console.log(x);
         }
       } while (true);
+  - no-match: |
+      while (true) {
+        let fn = function () {
+          return;
+        }
+        return;
+      }

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/binary-operator-identity.yaml

@@ -1,6 +1,9 @@
 rules:
 - id: binary-operator-identity
   description: Simplify binary operation
+  explanation: |
+    Some identities can be applied to simplify certain binary operations. For example
+    writing `x - x` is a complicated way of saying `0`.
   language: javascript
   tags:
   - default

sourcery_nightly-1.0.10b1.data/purelib/sourcery/javascript_rules/use-object-destructuring.yaml → sourcery_nightly-1.0.10b6.data/purelib/sourcery/javascript_rules/combine-object-destructuring.yaml

@@ -1,39 +1,11 @@
 rules:
-  # These two rules together convert a series of property accesses into a single destructuring access.
-
-- id: use-object-destructuring
-  description: Prefer object destructuring when accessing and using properties.
+- id: combine-object-destructuring
+  description: Combine destructure assignments.
   explanation: |
     Object destructuring can often remove an unnecessary temporary reference, as well as making your code more succinct.
 
     From the [Airbnb Javascript Style Guide](https://airbnb.io/javascript/#destructuring--object)
   language: javascript
-  tags:
-  - airbnb-javascript-style-guide
-  - airbnb
-  - default
-  any:
-  - pattern: |
-      const ${property} = ${object}.${property}
-    replacement: |
-      const {${property}} = ${object}
-  - pattern: |
-      let ${property} = ${object}.${property}
-    replacement: |
-      let {${property}} = ${object}
-  tests:
-  - match: |
-      const firstName = user.firstName;
-    expect: |
-      const {firstName} = user;
-  - match: |
-      let firstName = user.firstName;
-    expect: |
-      let {firstName} = user;
-
-- id: combine-object-destructuring
-  description: Combine destructure assignments.
-  language: javascript
   any:
   - pattern: |
       const {...} = ${object};

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/dont-shadow-arguments.yaml

@@ -13,8 +13,23 @@ rules:
   - default
   all:
   - pattern: arguments
+  # give this capture a name
+  - pattern: ${capture}
   - inside:
-      kind: formal_parameters   # TODO Want this to be direct child-parent
+      # check if `arguments` is a parameter
+      any:
+      - pattern: |
+          (..., ${capture}, ...)
+        as-in: |
+          function ${pattern} {}
+      - pattern: |
+          (..., ${capture}=..., ...)
+        as-in: |
+          function ${pattern} {}
+      - pattern: |
+          (..., ...${capture}, ...)
+        as-in: |
+          function ${pattern} {}
   tests:
   - match: |
       function foo(name, options, arguments) {
@@ -24,7 +39,7 @@ rules:
       function foo(name, options, arguments=something) {
         something();
       }
-  - match: | # TODO This is a false positive - but should be v rare
+  - no-match: |
       function foo(name, options, arg=arguments()) {
         something();
       }

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/misplaced-break-or-continue.yaml

@@ -1,6 +1,8 @@
 rules:
 - id: misplaced-break-or-continue
   description: This `break` or `continue` does not refer to any valid loop or statement.
+  explanation: |
+    A `break` or `continue` cannot be outside a suitable loop or block statement.
   language: javascript
   tags:
   - default

sourcery_nightly-1.0.10b6.data/purelib/sourcery/javascript_rules/no-eval.yaml

@@ -0,0 +1,19 @@
+rules:
+- id: no-eval
+  description: Never use `eval()`
+  explanation: |
+    Using `eval` opens your code up to serious security risks - it executes
+    code with the privileges of the caller, leading to all sorts of possible attacks.
+
+    It can also cause performance issues, preventing javascript minifiers and interpreters
+    from making many efficiency gains.
+  any:
+  - pattern: eval(${value})
+  - pattern: window.eval(${value})
+  - pattern: globalThis.eval(${value})
+  tags:
+  - default
+  language: javascript
+  tests:
+  - match: eval("throw 1")
+  - no-match: obj.eval("throw 1")

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/no-new-symbol.yaml

@@ -1,6 +1,8 @@
 rules:
 - id: no-new-symbol
   description: An instance of `Symbol` can only be created using `Symbol` as a function
+  explanation: |
+    `Symbol` is not intended to be used with the `new` operator, but called as a function.
   language: javascript
   tags:
   - default

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/remove-redundant-boolean.yaml

@@ -1,13 +1,14 @@
 rules:
 - id: remove-redundant-boolean
   description: Remove unnecessary boolean value
+  explanation: |
+    This rule removes unnecessary `true` values from `&&` boolean operators, since
+    `something && true` has exactly the same meaning as `something`
   language: javascript
   tags:
   - default
 # TODO We haven't currently got the node dependency checks to remove falses or things in ors
   any:
-  - pattern: '... && true && ...'
-    replacement: '... && ...'
   - pattern: true && ...
     replacement: '...'
   - pattern: '... && true'

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/simplify-ternary.yaml

@@ -1,6 +1,9 @@
 rules:
 - id: simplify-ternary
   description: Avoid unneeded ternary statements
+  explanation: |
+    It is possible to simplify certain ternary statements into either use of an `||` or `!`.
+    This makes the code easier to read, since there is no conditional logic.
   language: javascript
   tags:
   - default

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/use-braces.yaml

@@ -1,6 +1,12 @@
 rules:
 - id: use-braces
   description: Use block braces for ifs, whiles, etc.
+  explanation: |
+    It is recommended to always use braces and create explicit statement blocks.
+
+    Using the allowed syntax to just write a single statement can lead to very confusing
+    situations, especially where subsequently a developer might add another statement
+    while forgetting to add the braces (meaning that this wouldn't be included in the condition).
   language: javascript
   tags:
   - default

sourcery_nightly-1.0.10b6.data/purelib/sourcery/javascript_rules/use-object-destructuring.yaml

@@ -0,0 +1,32 @@
+rules:
+  # This combines with `combine-object-destructuring` to convert a series of property accesses into a single destructuring access.
+
+- id: use-object-destructuring
+  description: Prefer object destructuring when accessing and using properties.
+  explanation: |
+    Object destructuring can often remove an unnecessary temporary reference, as well as making your code more succinct.
+
+    From the [Airbnb Javascript Style Guide](https://airbnb.io/javascript/#destructuring--object)
+  language: javascript
+  tags:
+  - airbnb-javascript-style-guide
+  - airbnb
+  - default
+  any:
+  - pattern: |
+      const ${property} = ${object}.${property}
+    replacement: |
+      const {${property}} = ${object}
+  - pattern: |
+      let ${property} = ${object}.${property}
+    replacement: |
+      let {${property}} = ${object}
+  tests:
+  - match: |
+      const firstName = user.firstName;
+    expect: |
+      const {firstName} = user;
+  - match: |
+      let firstName = user.firstName;
+    expect: |
+      let {firstName} = user;

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/use-ternary-operator.yaml

@@ -1,6 +1,9 @@
 rules:
 - id: use-ternary-operator
   description: Replace if statement with ternary operator
+  explanation: |
+    The ternary operator is a simpler and more elegant way to write conditional assignments
+    to a variable than the long form.
   language: javascript
   tags:
   - default

{sourcery_nightly-1.0.10b1.data → sourcery_nightly-1.0.10b6.data}/purelib/sourcery/javascript_rules/while-guard-to-condition.yaml

@@ -1,6 +1,9 @@
 rules:
 - id: while-guard-to-condition
   description: Move a guard clause in a while statement's body into its test
+  explanation: |
+    A guard clause with a `break` that is the first thing in a `while` body is
+    equivalent to having the condition contained in the `while` itself.
   language: javascript
   tags:
   - default
@@ -12,12 +15,6 @@ rules:
           }
           ...
       }
-  - pattern: |
-      while (${cond_a}) {
-          if (${cond_b})
-              break;
-          ...
-      }
   replacement: |
     while (${cond_a} && !${cond_b}) {
         ...

{sourcery_nightly-1.0.10b1.dist-info → sourcery_nightly-1.0.10b6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sourcery-nightly
-Version: 1.0.10b1
+Version: 1.0.10b6
 Summary: Magically refactor Python
 Home-page: https://github.com/sourcery-ai/sourcery
 Author: Sourcery AI
@@ -110,7 +110,7 @@ _Sourcery_ works great with [pre-commit](https://pre-commit.com). Once you
 ```yaml
 repos:
   - repo: https://github.com/sourcery-ai/sourcery
-    rev: v1.0.10b1
+    rev: v1.0.10b6
     hooks:
       - id: sourcery
         # The best way to use Sourcery in a pre-commit hook: