Docs Update

Author: SebastianWendorf

docs/development/Concepts.md

@@ -16,4 +16,4 @@ aliases:
 
 **`ConceptMap`:**
 - [Concept Maps](https://jqassistant-plugin.github.io/jqassistant-lce-docs/architecture/Concept-Map) are realized in their more complex form, integrating parent property names into their index structure
-- use `mergeConceptMaps`, `unifyConceptMap`, `singleEntryConceptMap`, `createConceptMap`, and `getAndCastConcepts` utility functions for concise usage of `ConceptMap` instances
+- use `mergeConceptMaps`, `unifyConceptMap`, `singleEntryConceptMap`, `createConceptMap`, and `getAndCastConcepts` utility functions for the concise management of `ConceptMap` instances

docs/development/Extraction Strategy - Overview.md

@@ -0,0 +1,10 @@
+# Extraction Strategy: Overview
+-> the extraction of language concepts is achieved by an implementation of the [LCE Architecture](https://jqassistant-plugin.github.io/jqassistant-lce-docs/)
+
+- the main source of information for extracting concepts from TS source code is the ESLint AST (provided through `@typescript-eslint/typescript-estree`)
+	- use [ESLint Playground](https://typescript-eslint.io/play/) to easily explore the data structures
+- all concepts have to be extracted within a single traversal of the ESLint AST
+	- separate/additional sub-tree traversals are not allowed
+- additional information, mostly related to types, is extracted via the native TypeScript Compiler API (for more information see [here](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) and [here](https://github.com/microsoft/TypeScript-Compiler-Notes/blob/main/README.md)), especially the TypeChecker
+	- direct translation between nodes of the two different ASTs can easily be done via the `services` global context
+	- the Compiler API should be used sparingly, as it is less developer-friendly than the ESLint API

docs/development/Local Contexts.md

@@ -0,0 +1,7 @@
+# Local Contexts
+-> [Local Contexts](https://jqassistant-plugin.github.io/jqassistant-lce-docs/architecture/Local-Contexts) are implemented by the `LocalContexts` class
+- located under `typescript/src/core/context.ts`
+
+**General Usage Rules:**
+- child node [[Processors|processors]] should know as little as possible about their parents and should instead receive their information for execution conditions and concept extraction from local contexts (-> increase re-usability)
+- the context keys are stored in a central class that is specific for each extension (e.g. `CoreContextKeys` and `ReactContextKeys`) that is located in an extension-level module named `context.keys.ts`

docs/development/Traversers.md

@@ -6,7 +6,8 @@ aliases:
 -> [LCE traversers](https://jqassistant-plugin.github.io/jqassistant-lce-docs/architecture/Traversers) are implemented as a modified visitor pattern
 - The abstract `Traverser` base class provides the implementation that orchestrates the execution of the other components
 	- only the `traverseChildren` method that delegates the traversal of potential child nodes to other traversers is abstract and has to be implemented by sub types
-- for each AST node type (provided via `@typescript-eslint/utils`) that should be processed a separate `Traverser` implementation has to be provided
+- for each AST node type (provided via `@typescript-eslint/utils`) that should be processed, a separate `Traverser` implementation has to be provided
+	- note that skipping nodes in the ESLint AST through a simplified `Traverser` implementation (e.g. via nested node access: `runTraverserForNodes(node.body.body, ...)`) must be avoided as it leads to an incorrectly set `parent` property on the traversed child nodes
 - all traverser implementations are located under `typescript/src/core/traversers`
 	- all files end with `.traverser.ts`
 	- may export one or more traverser classes each
@@ -16,5 +17,6 @@ aliases:
 - all traversers need to be registered in the `TRAVERSERS` [feature collection](https://jqassistant-plugin.github.io/jqassistant-lce-docs/architecture/Feature-Collections) in `features.ts`
 	- before implementing a new traverser check if there already exists one in the collection
 	- existing traversers may not trigger the traversal for all their child nodes: expand where needed
+	- for nodes that don't have any children that should be traversed the `SimpleTraverser` default implementation can be specified in `TRAVERSERS` for the corresponding node type
 - use `runTraverserForNode`(`s`) utility function to easily delegate the traversal process
 - parent property names should be declared as `public static readonly` members of the implementing class

docs/index.md

@@ -47,9 +47,13 @@ This plugin is based on the [LCE Architecture](https://jqassistant-plugin.github
 - [[Codebase Layout]]
 - [[Extensions]]
 
-**LCE:**
+**Base LCE Architecture Implementation:**
 - [[Concepts]]
 - [[Traversers]]
 - [[Processors]]
 - [[Post-Processors]]
+- [[Local Contexts]]
 - [[Utilities]]
+
+**Extraction Strategies:**
+- *[[Extraction Strategy - Overview|Overview]]*

typescript/src/core/processor.ts

@@ -12,7 +12,7 @@ export type ProcessorMap = Map<AST_NODE_TYPES, Processor[]>;
  */
 export abstract class Processor {
     /**
-     * defines on what nodes and in which context the processor is executed
+     * defines on what nodes and in which context the processor will be executed
      */
     public abstract executionCondition: ExecutionCondition;