Merge pull request #5 from philenius/develop

Upgrade to Angular v11

Author: philenius

.eslintrc.json

@@ -0,0 +1,51 @@
+{
+  "root": true,
+  "ignorePatterns": [
+    "projects/**/*"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts"
+      ],
+      "parserOptions": {
+        "project": [
+          "tsconfig.json",
+          "e2e/tsconfig.json"
+        ],
+        "createDefaultProgram": true
+      },
+      "extends": [
+        "plugin:@angular-eslint/recommended",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "prefix": "lib",
+            "style": "kebab-case",
+            "type": "element"
+          }
+        ],
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "prefix": "lib",
+            "style": "camelCase",
+            "type": "attribute"
+          }
+        ]
+      }
+    },
+    {
+      "files": [
+        "*.html"
+      ],
+      "extends": [
+        "plugin:@angular-eslint/template/recommended"
+      ],
+      "rules": {}
+    }
+  ]
+}

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+        "Angular.ng-template"
+    ]
+}

README.md

@@ -8,8 +8,8 @@ An Angular component library for interactively highlighting / annotating parts o
 
 ## Features
 
-* :raised_hand: Interactively mark entities such as cities, numbers, dates, etc.
-* :x: Remove annotations / marked entities.
+* :point_up_2: Interactively mark entities such as cities, numbers, dates, etc.
+* :wastebasket: Interactively remove annotations / marked entities. 
 * :tada: Purely based on CSS. No magic, no canvas, and no SVGs.
 
 
@@ -95,7 +95,7 @@ For the demo application, please see the Angular app in `./src/app/`. Screen rec
        border-radius: 0rem !important;
    }
    ```
-    
+   
 
 
 
@@ -105,22 +105,23 @@ For the demo application, please see the Angular app in `./src/app/`. Screen rec
 
 | Input           | Description                                                  | Type         | Default value |
 | :-------------- | ------------------------------------------------------------ | ------------ | :------------ |
-| annotations     | Represents the parts of the given text which shall be annotated. | Annotation[] | []            |
-| annotationClass | An optional CSS class applied to all elements which wrap the annotated parts of the given text. | string       |               |
-| removable       | Determines whether annotations shall have a small button in the top right corner so that the user can remove an annotation. | boolean      | true          |
-| text            | The text which shall be displayed and annotated.             | string       |               |
+| annotations     | Represents the parts of the given text which shall be annotated. | `Annotation[]` | `[]`            |
+| annotationClass | An optional CSS class applied to all elements which wrap the annotated parts of the given text. | `string\|undefined`       | `undefined`               |
+| removable       | Determines whether annotations shall have a small button in the top right corner so that the user can remove an annotation. | `boolean`      | `true`           |
+| text            | The text which shall be displayed and annotated.             | `string`       | empty string              |
 
 ### Outputs
 
 | Output            | Description                                                  | Type                       |
 | ----------------- | ------------------------------------------------------------ | -------------------------- |
-| annotationsChange | Emits the list of existing annotations after an element has been removed by the user. | EventEmitter<Annotation[]> |
+| annotationsChange | Emits the list of existing annotations after an element has been removed by the user. | `EventEmitter<Annotation[]>` |
 
 ### Methods
 
-| Method                  | Description                                                  | Return type |
-| ----------------------- | ------------------------------------------------------------ | ----------- |
-| getCurrentTextSelection | Returns the start index and end index of the currently selected text range. Returns `undefined` if no text is currently selected. | ISelection  |
+| Method                               | Description                                                  | Return type |
+| ------------------------------------ | ------------------------------------------------------------ | ----------- |
+| getCurrentTextSelection              | Returns the start index and end index of the currently selected text range. Returns `undefined` if no text is currently selected. | `ISelection\|undefined` |
+| isOverlappingWithExistingAnnotations | Returns true if the given text selection is (partially) overlapping with an existing annotation. Returns false otherwise. | `boolean` |
 
 
 
@@ -132,7 +133,7 @@ Run `ng build ngx-annotate-text` to build the project. The build artifacts will
 
 ### Running linting tools
 
-Run `ng lint ngx-annotate-text ` to execute TSLint.
+Run `ng lint ngx-annotate-text ` to execute ESLint.
 
 ### Running unit tests
 

angular.json

@@ -95,15 +95,11 @@
           }
         },
         "lint": {
-          "builder": "@angular-devkit/build-angular:tslint",
+          "builder": "@angular-eslint/builder:lint",
           "options": {
-            "tsConfig": [
-              "tsconfig.app.json",
-              "tsconfig.spec.json",
-              "e2e/tsconfig.json"
-            ],
-            "exclude": [
-              "**/node_modules/**"
+            "lintFilePatterns": [
+              "src/**/*.ts",
+              "src/**/*.html"
             ]
           }
         },
@@ -148,18 +144,19 @@
           }
         },
         "lint": {
-          "builder": "@angular-devkit/build-angular:tslint",
+          "builder": "@angular-eslint/builder:lint",
           "options": {
-            "tsConfig": [
-              "projects/ngx-annotate-text/tsconfig.lib.json",
-              "projects/ngx-annotate-text/tsconfig.spec.json"
-            ],
-            "exclude": [
-              "**/node_modules/**"
+            "lintFilePatterns": [
+              "projects/ngx-annotate-text/**/*.ts",
+              "projects/ngx-annotate-text/**/*.html"
             ]
           }
         }
       }
-    }},
-  "defaultProject": "ngx-annotate-text-workspace"
+    }
+  },
+  "defaultProject": "ngx-annotate-text-workspace",
+  "cli": {
+    "defaultCollection": "@angular-eslint/schematics"
+  }
 }