Make the indent rules supports TypeScript

Author: ota-meshi

lib/utils/indent-common.js

@@ -0,0 +1,113 @@
+'use strict'
+
+/**
+ * Check whether the given token is a wildcard.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is a wildcard.
+ */
+function isWildcard(token) {
+  return token != null && token.type === 'Punctuator' && token.value === '*'
+}
+
+/**
+ * Check whether the given token is a question.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is a question.
+ */
+function isQuestion(token) {
+  return token != null && token.type === 'Punctuator' && token.value === '?'
+}
+
+/**
+ * Check whether the given token is an extends keyword.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is an extends keywordn.
+ */
+function isExtendsKeyword(token) {
+  return token != null && token.type === 'Keyword' && token.value === 'extends'
+}
+
+/**
+ * Check whether the given token is a whitespace.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is a whitespace.
+ */
+function isNotWhitespace(token) {
+  return token != null && token.type !== 'HTMLWhitespace'
+}
+
+/**
+ * Check whether the given token is a comment.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is a comment.
+ */
+function isComment(token) {
+  return (
+    token != null &&
+    (token.type === 'Block' ||
+      token.type === 'Line' ||
+      token.type === 'Shebang' ||
+      (typeof token.type ===
+        'string' /* Although acorn supports new tokens, espree may not yet support new tokens.*/ &&
+        token.type.endsWith('Comment')))
+  )
+}
+
+/**
+ * Check whether the given token is a comment.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `false` if the token is a comment.
+ */
+function isNotComment(token) {
+  return (
+    token != null &&
+    token.type !== 'Block' &&
+    token.type !== 'Line' &&
+    token.type !== 'Shebang' &&
+    !(
+      typeof token.type ===
+        'string' /* Although acorn supports new tokens, espree may not yet support new tokens.*/ &&
+      token.type.endsWith('Comment')
+    )
+  )
+}
+
+/**
+ * Check whether the given node is not an empty text node.
+ * @param {ASTNode} node The node to check.
+ * @returns {boolean} `false` if the token is empty text node.
+ */
+function isNotEmptyTextNode(node) {
+  return !(node.type === 'VText' && node.value.trim() === '')
+}
+
+/**
+ * Check whether the given token is a pipe operator.
+ * @param {Token|undefined|null} token The token to check.
+ * @returns {boolean} `true` if the token is a pipe operator.
+ */
+function isPipeOperator(token) {
+  return token != null && token.type === 'Punctuator' && token.value === '|'
+}
+
+/**
+ * Get the last element.
+ * @template T
+ * @param {T[]} xs The array to get the last element.
+ * @returns {T | undefined} The last element or undefined.
+ */
+function last(xs) {
+  return xs.length === 0 ? undefined : xs[xs.length - 1]
+}
+
+module.exports = {
+  isWildcard,
+  isQuestion,
+  isExtendsKeyword,
+  isNotWhitespace,
+  isComment,
+  isNotComment,
+  isNotEmptyTextNode,
+  isPipeOperator,
+  last
+}

lib/utils/indent-ts.js

@@ -63,7 +63,7 @@
     "@types/natural-compare": "^1.4.0",
     "@types/node": "^13.13.5",
     "@types/semver": "^7.2.0",
-    "@typescript-eslint/parser": "^3.0.2",
+    "@typescript-eslint/parser": "^4.28.0",
     "@vuepress/plugin-pwa": "^1.4.1",
     "babel-eslint": "^10.1.0",
     "env-cmd": "^10.1.0",

lib/utils/indent-utils.js

@@ -0,0 +1,19 @@
+<!--{"options":[2, {"ignores": ["ArrayExpression"]}]}-->
+<script>
+var a =
+[
+{
+a: 42
+}
+]
+var x = {
+  a:
+[],
+  b:
+    1,
+  c:
+    {},
+  d:
+    2
+}
+</script>

package.json

@@ -0,0 +1,19 @@
+<!--{"options":[2, {"ignores": ["ObjectExpression"]}]}-->
+<script>
+var a =
+  [
+{
+a: 42
+}
+  ]
+var x = {
+a:
+[],
+b:
+1,
+c:
+{},
+d:
+2
+}
+</script>

tests/fixtures/script-indent/ignore-01.vue

@@ -0,0 +1,22 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+abstract class A {
+  abstract a;
+  abstract public b;
+  public abstract c;
+  abstract protected d;
+  protected abstract e;
+  abstract private f;
+  private abstract g;
+}
+
+abstract class B {
+  readonly abstract a;
+  abstract readonly b;
+  abstract readonly public c;
+  public abstract readonly d;
+  public readonly abstract e;
+  public static readonly  a;
+  public abstract readonly  a;
+}
+</script>

tests/fixtures/script-indent/ignore-02.vue

@@ -0,0 +1,17 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+abstract class A {
+  a
+    =
+    1
+  ;
+  abstract public b
+    =
+    's'
+  ;
+  protected abstract c
+    =
+    i
+  ;
+}
+</script>

tests/fixtures/script-indent/ts-abstract-class-property-01.vue

@@ -0,0 +1,30 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+abstract class A {
+  abstract a ();
+  abstract public b(
+  );
+  public abstract c
+    ();
+  abstract protected d(
+    p1,
+    p2
+  );
+  protected abstract e(
+    p1
+    ,p2
+  )
+  abstract private f(
+    p1
+    ,
+    p2
+  )
+  ;
+  private abstract g();
+  private abstract async h(
+    p1
+    ,
+    p2
+  );
+}
+</script>

tests/fixtures/script-indent/ts-abstract-class-property-02.vue

@@ -0,0 +1,6 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+var foo =
+  bar as
+    boolean
+</script>

tests/fixtures/script-indent/ts-abstract-method-definition-01.vue

@@ -0,0 +1,13 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+interface Foo {
+  (
+    arg1
+    ,
+    arg2
+  )
+    :
+    string
+  ;
+}
+</script>

tests/fixtures/script-indent/ts-as-expression-01.vue

@@ -0,0 +1,13 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+type Foo = {
+  (
+    arg1
+    ,
+    arg2
+  )
+    :
+    string
+  ;
+}
+</script>

tests/fixtures/script-indent/ts-call-signature-declaration-01.vue

@@ -0,0 +1,11 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class
+  Foo
+    <
+      T
+    >
+{
+  prop:string
+}
+</script>

tests/fixtures/script-indent/ts-call-signature-declaration-02.vue

@@ -0,0 +1,16 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class
+  Foo
+    <
+      T
+    >
+  extends
+    Bar
+      <
+        T
+      >
+{
+  prop:string
+}
+</script>

tests/fixtures/script-indent/ts-class-declaration-01.vue

@@ -0,0 +1,26 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class
+  Foo
+    <
+      T
+    >
+  extends
+    Bar
+      <
+        T
+      >
+  implements
+    Baz1
+      <
+        T
+      >
+    ,
+    Baz2
+      <
+        T
+      >
+{
+  prop:string
+}
+</script>

tests/fixtures/script-indent/ts-class-declaration-02.vue

@@ -0,0 +1,26 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class
+  Foo
+    <
+      T
+    >
+  implements
+    Baz1
+      <
+        T
+      >
+    ,
+    Baz2
+      <
+        T
+      >
+  extends
+    Bar
+      <
+        T
+      >
+{
+  prop:string
+}
+</script>

tests/fixtures/script-indent/ts-class-declaration-03.vue

@@ -0,0 +1,14 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class
+  Foo
+  implements
+    Baz1
+    ,
+    Baz2
+  extends
+    Bar
+{
+  prop:string
+}
+</script>

tests/fixtures/script-indent/ts-class-declaration-04.vue

@@ -0,0 +1,15 @@
+<!--{"parserOptions": {"parser":"@typescript-eslint/parser"}}-->
+<script lang="ts">
+class A {
+  a;
+  public b;
+  protected c;
+  private d;
+}
+
+class B {
+  readonly a;
+  readonly public b;
+  protected readonly c;
+}
+</script>