chore: Add docs placeholders.

cartant · Aug 17, 2020 · 193a53c · 193a53c
1 parent a53ab66
commit 193a53c
Show file tree

Hide file tree

Showing 77 changed files with 181 additions and 63 deletions.
diff --git a/docs/rules/ban-observables.md b/docs/rules/ban-observables.md
@@ -0,0 +1,3 @@
+# ban-observables
+
+TK
diff --git a/docs/rules/ban-operators.md b/docs/rules/ban-operators.md
@@ -0,0 +1,3 @@
+# ban-operators
+
+TK
diff --git a/docs/rules/finnish.md b/docs/rules/finnish.md
@@ -0,0 +1,3 @@
+# finnish
+
+TK
diff --git a/docs/rules/just.md b/docs/rules/just.md
@@ -0,0 +1,3 @@
+# just
+
+TK
diff --git a/docs/rules/macro.md b/docs/rules/macro.md
@@ -0,0 +1,3 @@
+# macro
+
+TK
diff --git a/docs/rules/no-async-subscribe.md b/docs/rules/no-async-subscribe.md
@@ -0,0 +1,3 @@
+# no-async-subscribe
+
+TK
diff --git a/docs/rules/no-compat.md b/docs/rules/no-compat.md
@@ -0,0 +1,3 @@
+# no-compat
+
+TK
diff --git a/docs/rules/no-connectable.md b/docs/rules/no-connectable.md
@@ -0,0 +1,3 @@
+# no-connectable
+
+TK
diff --git a/docs/rules/no-create.md b/docs/rules/no-create.md
@@ -0,0 +1,3 @@
+# no-create
+
+TK
diff --git a/docs/rules/no-explicit-generics.md b/docs/rules/no-explicit-generics.md
@@ -0,0 +1,3 @@
+# no-explicit-generics
+
+TK
diff --git a/docs/rules/no-exposed-subjects.md b/docs/rules/no-exposed-subjects.md
@@ -0,0 +1,3 @@
+# no-exposed-subjects
+
+TK
diff --git a/docs/rules/no-finnish.md b/docs/rules/no-finnish.md
@@ -0,0 +1,3 @@
+# no-finnish
+
+TK
diff --git a/docs/rules/no-ignored-error.md b/docs/rules/no-ignored-error.md
@@ -0,0 +1,3 @@
+# no-ignored-error
+
+TK
diff --git a/docs/rules/no-ignored-notifier.md b/docs/rules/no-ignored-notifier.md
@@ -0,0 +1,3 @@
+# no-ignored-notifier
+
+TK
diff --git a/docs/rules/no-ignored-observable.md b/docs/rules/no-ignored-observable.md
@@ -0,0 +1,3 @@
+# no-ignored-observable
+
+TK
diff --git a/docs/rules/no-ignored-replay-buffer.md b/docs/rules/no-ignored-replay-buffer.md
@@ -0,0 +1,3 @@
+# no-ignored-replay-buffer
+
+TK
diff --git a/docs/rules/no-ignored-subscribe.md b/docs/rules/no-ignored-subscribe.md
@@ -0,0 +1,3 @@
+# no-ignored-subscribe
+
+TK
diff --git a/docs/rules/no-ignored-subscription.md b/docs/rules/no-ignored-subscription.md
@@ -0,0 +1,3 @@
+# no-ignored-subscription
+
+TK
diff --git a/docs/rules/no-ignored-takewhile-value.md b/docs/rules/no-ignored-takewhile-value.md
@@ -0,0 +1,3 @@
+# no-ignored-takewhile-value
+
+TK
diff --git a/docs/rules/no-implicit-any-catch.md b/docs/rules/no-implicit-any-catch.md
@@ -0,0 +1,3 @@
+# no-implicit-any-catch
+
+TK
diff --git a/docs/rules/no-index.md b/docs/rules/no-index.md
@@ -0,0 +1,3 @@
+# no-index
+
+TK
diff --git a/docs/rules/no-internal.md b/docs/rules/no-internal.md
@@ -0,0 +1,3 @@
+# no-internal
+
+TK
diff --git a/docs/rules/no-nested-subscribe.md b/docs/rules/no-nested-subscribe.md
@@ -0,0 +1,3 @@
+# no-nested-subscribe
+
+TK
diff --git a/docs/rules/no-redundant-notify.md b/docs/rules/no-redundant-notify.md
@@ -0,0 +1,3 @@
+# no-redundant-notify
+
+TK
diff --git a/docs/rules/no-sharereplay.md b/docs/rules/no-sharereplay.md
@@ -0,0 +1,3 @@
+# no-sharereplay
+
+TK
diff --git a/docs/rules/no-subclass.md b/docs/rules/no-subclass.md
@@ -0,0 +1,3 @@
+# no-subclass
+
+TK
diff --git a/docs/rules/no-subject-unsubscribe.md b/docs/rules/no-subject-unsubscribe.md
@@ -0,0 +1,3 @@
+# no-subject-unsubscribe
+
+TK
diff --git a/docs/rules/no-subject-value.md b/docs/rules/no-subject-value.md
@@ -0,0 +1,3 @@
+# no-subject-value
+
+TK
diff --git a/docs/rules/no-tap.md b/docs/rules/no-tap.md
@@ -0,0 +1,3 @@
+# no-tap
+
+TK
diff --git a/docs/rules/no-topromise.md b/docs/rules/no-topromise.md
@@ -0,0 +1,3 @@
+# no-topromise
+
+TK
diff --git a/docs/rules/no-unbound-methods.md b/docs/rules/no-unbound-methods.md
@@ -0,0 +1,3 @@
+# no-unbound-methods
+
+TK
diff --git a/docs/rules/no-unsafe-catch.md b/docs/rules/no-unsafe-catch.md
@@ -0,0 +1,3 @@
+# no-unsafe-catch
+
+TK
diff --git a/docs/rules/no-unsafe-first.md b/docs/rules/no-unsafe-first.md
@@ -0,0 +1,3 @@
+# no-unsafe-first
+
+TK
diff --git a/docs/rules/no-unsafe-subject-next.md b/docs/rules/no-unsafe-subject-next.md
@@ -0,0 +1,3 @@
+# no-unsafe-subject-next
+
+TK
diff --git a/docs/rules/no-unsafe-switchmap.md b/docs/rules/no-unsafe-switchmap.md
@@ -0,0 +1,3 @@
+# no-unsafe-switchmap
+
+TK
diff --git a/docs/rules/no-unsafe-takeuntil.md b/docs/rules/no-unsafe-takeuntil.md
@@ -0,0 +1,3 @@
+# no-unsafe-takeuntil
+
+TK
diff --git a/docs/rules/prefer-observer.md b/docs/rules/prefer-observer.md
@@ -0,0 +1,3 @@
+# prefer-observer
+
+TK
diff --git a/docs/rules/suffix-subjects.md b/docs/rules/suffix-subjects.md
@@ -0,0 +1,3 @@
+# suffix-subjects
+
+TK
diff --git a/docs/rules/throw-error.md b/docs/rules/throw-error.md
@@ -0,0 +1,3 @@
+# throw-error
+
+TK
diff --git a/source/rules/ban-observables.ts b/source/rules/ban-observables.ts
@@ -17,7 +17,7 @@ const rule = ruleCreator({
       description: "Forbids the use of banned observables.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "RxJS observable is banned: {{name}}{{explanation}}.",
     },

diff --git a/source/rules/ban-operators.ts b/source/rules/ban-operators.ts
@@ -17,7 +17,7 @@ const rule = ruleCreator({
       description: "Forbids the use of banned operators.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "RxJS operator is banned: {{name}}{{explanation}}.",
     },

diff --git a/source/rules/just.ts b/source/rules/just.ts
@@ -18,7 +18,7 @@ const rule = ruleCreator({
     messages: {
       forbidden: "Use just alias.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "just",

diff --git a/source/rules/macro.ts b/source/rules/macro.ts
@@ -21,7 +21,7 @@ const rule = ruleCreator({
     messages: {
       macro: "Use the RxJS Tools Babel macro.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "macro",

diff --git a/source/rules/no-async-subscribe.ts b/source/rules/no-async-subscribe.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids passing `async` functions to `subscribe`.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Passing async functions to subscribe is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-async-subscribe",

diff --git a/source/rules/no-compat.ts b/source/rules/no-compat.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
         "Forbids importation from locations that depend upon `rxjs-compat`.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "'rxjs-compat'-dependent import locations are forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-compat",

diff --git a/source/rules/no-connectable.ts b/source/rules/no-connectable.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids operators that return connectable observables.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Connectable observables are forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-connectable",

diff --git a/source/rules/no-create.ts b/source/rules/no-create.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids the calling of `Observable.create`.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Observable.create is forbidden; use new Observable.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-create",

diff --git a/source/rules/no-explicit-generics.ts b/source/rules/no-explicit-generics.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids explicit generic type arguments.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Explicit generic type arguments are forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-explicit-generics",

diff --git a/source/rules/no-exposed-subjects.ts b/source/rules/no-exposed-subjects.ts
@@ -20,7 +20,7 @@ const rule = ruleCreator({
       description: "Forbids exposed (i.e. non-private) subjects.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Subject '{{subject}}' must be private.",
       forbiddenAllowProtected:

diff --git a/source/rules/no-finnish.ts b/source/rules/no-finnish.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids the use of Finnish notation.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Finnish notation is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-finnish",

diff --git a/source/rules/no-ignored-error.ts b/source/rules/no-ignored-error.ts
@@ -16,11 +16,11 @@ const rule = ruleCreator({
         "Forbids the calling of `subscribe` without specifying an error handler.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Calling subscribe without an error handler is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-ignored-error",

diff --git a/source/rules/no-ignored-notifier.ts b/source/rules/no-ignored-notifier.ts
@@ -20,11 +20,11 @@ const rule = ruleCreator({
         "Forbids observables not composed from the `repeatWhen` or `retryWhen` notifier.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Ignoring the notifier is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-ignored-notifier",

diff --git a/source/rules/no-ignored-observable.ts b/source/rules/no-ignored-observable.ts
@@ -15,11 +15,11 @@ const rule = ruleCreator({
       description: "Forbids the ignoring of observables returned by functions.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Ignoring a returned Observable is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-ignored-observable",

diff --git a/source/rules/no-ignored-replay-buffer.ts b/source/rules/no-ignored-replay-buffer.ts
@@ -16,11 +16,11 @@ const rule = ruleCreator({
         "Forbids using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Ignoring the buffer size is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-ignored-replay-buffer",

diff --git a/source/rules/no-ignored-subscribe.ts b/source/rules/no-ignored-subscribe.ts
@@ -16,11 +16,11 @@ const rule = ruleCreator({
         "Forbids the calling of `subscribe` without specifying arguments.",
       recommended: false,
     },
-    fixable: null,
+    fixable: undefined,
     messages: {
       forbidden: "Calling subscribe without arguments is forbidden.",
     },
-    schema: null,
+    schema: [],
     type: "problem",
   },
   name: "no-ignored-subscribe",