add module alias '@tests/'

Alias would remove unnecessary repetitions and less relative paths make changes easier when moving around files. This commit cleans also up some relative paths ('../../../') by using the alias and orders imports. It updates both path alias in tsconfig and module alias in Vue CLI's bundler (vuejs/vue-cli#2398).

docs/tests.md

@@ -1,16 +1,20 @@
-# Unit tests
+# Tests
+
+- 💡 You can use path/module alias `@/tests` in import statements.
+
+## Unit tests
 
 - Unit tests are defined in [`./tests`](./../tests)
 - They follow same folder structure as [`./src`](./../src)
 
-## Naming
+### Naming
 
 - Each test suite first describe the system under test
   - E.g. tests for class `Application` is categorized under `Application`
 - Tests for specific methods are categorized under method name (if applicable)
   - E.g. test for `run()` is categorized under `run`
 
-## Act, arrange, assert
+### Act, arrange, assert
 
 - Tests use act, arrange and assert (AAA) pattern when applicable
 - **Arrange**
@@ -23,7 +27,7 @@
   - Should elicit some sort of response
   - Starts with comment line `// assert`
 
-## Stubs
+### Stubs
 
 - Stubs are defined in [`./tests/stubs`](./../tests/unit/stubs)
 - They implement dummy behavior to be functional

src/application/Parser/Script/CategoryCollectionParseContext.ts

@@ -1,6 +1,6 @@
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
 import { ILanguageSyntax } from '@/domain/ScriptCode';
-import { FunctionData } from 'js-yaml-loader!*';
+import { FunctionData } from 'js-yaml-loader!@/*';
 import { IScriptCompiler } from './Compiler/IScriptCompiler';
 import { ScriptCompiler } from './Compiler/ScriptCompiler';
 import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';

src/application/Parser/Script/Compiler/Function/FunctionCompiler.ts

@@ -1,4 +1,4 @@
-import { FunctionData, InstructionHolder } from 'js-yaml-loader!*';
+import { FunctionData, InstructionHolder } from 'js-yaml-loader!@/*';
 import { SharedFunction } from './SharedFunction';
 import { SharedFunctionCollection } from './SharedFunctionCollection';
 import { ISharedFunctionCollection } from './ISharedFunctionCollection';

src/application/Parser/Script/Compiler/Function/IFunctionCompiler.ts

@@ -1,4 +1,4 @@
-import { FunctionData } from 'js-yaml-loader!*';
+import { FunctionData } from 'js-yaml-loader!@/*';
 import { ISharedFunctionCollection } from './ISharedFunctionCollection';
 
 export interface IFunctionCompiler {

src/application/Parser/Script/Compiler/FunctionCall/FunctionCallCompiler.ts

@@ -1,4 +1,4 @@
-import { FunctionCallData, FunctionCallParametersData, FunctionData, ScriptFunctionCallData } from 'js-yaml-loader!*';
+import { FunctionCallData, FunctionCallParametersData, FunctionData, ScriptFunctionCallData } from 'js-yaml-loader!@/*';
 import { ICompiledCode } from './ICompiledCode';
 import { ISharedFunctionCollection } from '../Function/ISharedFunctionCollection';
 import { IFunctionCallCompiler } from './IFunctionCallCompiler';

src/application/Parser/Script/Compiler/FunctionCall/IFunctionCallCompiler.ts

@@ -1,4 +1,4 @@
-import { ScriptFunctionCallData } from 'js-yaml-loader!*';
+import { ScriptFunctionCallData } from 'js-yaml-loader!@/*';
 import { ICompiledCode } from './ICompiledCode';
 import { ISharedFunctionCollection } from '../Function/ISharedFunctionCollection';
 

src/application/collections/collection.yaml.d.ts

@@ -1,4 +1,4 @@
-declare module 'js-yaml-loader!*' {
+declare module 'js-yaml-loader!@/*' {
     export interface CollectionData {
         readonly os: string;
         readonly scripting: ScriptingDefinitionData;

tests/unit/application/ApplicationFactory.spec.ts

@@ -1,7 +1,7 @@
 import 'mocha';
 import { expect } from 'chai';
 import { ApplicationFactory, ApplicationGetter } from '@/application/ApplicationFactory';
-import { ApplicationStub } from '../stubs/ApplicationStub';
+import { ApplicationStub } from '@tests/unit/stubs/ApplicationStub';
 
 describe('ApplicationFactory', () => {
     describe('ctor', () => {

tests/unit/application/Common/ScriptingLanguage/ScriptingLanguageFactory.spec.ts

@@ -3,7 +3,7 @@ import { expect } from 'chai';
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
 import { ScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/ScriptingLanguageFactory';
 import { ScriptingLanguageFactoryTestRunner } from './ScriptingLanguageFactoryTestRunner';
-import { EnumRangeTestRunner } from '../EnumRangeTestRunner';
+import { EnumRangeTestRunner } from '@tests/unit/application/Common/EnumRangeTestRunner';
 
 class ScriptingLanguageConcrete extends ScriptingLanguageFactory<number> {
     public registerGetter(language: ScriptingLanguage, getter: () => number) {

tests/unit/application/Common/ScriptingLanguage/ScriptingLanguageFactoryTestRunner.ts

@@ -1,7 +1,8 @@
+import 'mocha';
+import { expect } from 'chai';
 import { IScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/IScriptingLanguageFactory';
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
-import { expect } from 'chai';
-import { EnumRangeTestRunner } from '../EnumRangeTestRunner';
+import { EnumRangeTestRunner } from '@tests/unit/application/Common/EnumRangeTestRunner';
 
 export class ScriptingLanguageFactoryTestRunner<T> {
     private expectedTypes = new Map<ScriptingLanguage, T>();

tests/unit/application/Context/ApplicationContext.spec.ts

@@ -5,9 +5,9 @@ import { OperatingSystem } from '@/domain/OperatingSystem';
 import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
 import { IApplicationContext, IApplicationContextChangedEvent } from '@/application/Context/IApplicationContext';
 import { IApplication } from '@/domain/IApplication';
-import { ApplicationStub } from '../../stubs/ApplicationStub';
-import { CategoryCollectionStub } from '../../stubs/CategoryCollectionStub';
-import { EnumRangeTestRunner } from '../Common/EnumRangeTestRunner';
+import { ApplicationStub } from '@tests/unit/stubs/ApplicationStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
+import { EnumRangeTestRunner } from '@tests/unit/application/Common/EnumRangeTestRunner';
 
 describe('ApplicationContext', () => {
     describe('changeContext', () => {

tests/unit/application/Context/ApplicationContextFactory.spec.ts

@@ -2,12 +2,12 @@ import 'mocha';
 import { expect } from 'chai';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import { CategoryCollectionStub } from '../../stubs/CategoryCollectionStub';
-import { EnvironmentStub } from '../../stubs/EnvironmentStub';
-import { ApplicationStub } from '../../stubs/ApplicationStub';
 import { buildContextAsync } from '@/application/Context/ApplicationContextFactory';
 import { IApplicationFactory } from '@/application/IApplicationFactory';
 import { IApplication } from '@/domain/IApplication';
+import { EnvironmentStub } from '@tests/unit/stubs/EnvironmentStub';
+import { ApplicationStub } from '@tests/unit/stubs/ApplicationStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
 
 describe('ApplicationContextFactory', () => {
     describe('buildContextAsync', () => {

tests/unit/application/Context/State/CategoryCollectionState.spec.ts

@@ -5,9 +5,9 @@ import { ApplicationCode } from '@/application/Context/State/Code/ApplicationCod
 import { CategoryCollectionState } from '@/application/Context/State/CategoryCollectionState';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IScript } from '@/domain/IScript';
-import { ScriptStub } from '../../../stubs/ScriptStub';
-import { CategoryStub } from '../../../stubs/CategoryStub';
-import { CategoryCollectionStub } from '../../../stubs/CategoryCollectionStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
+import { CategoryStub } from '@tests/unit/stubs/CategoryStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
 
 describe('CategoryCollectionState', () => {
     describe('code', () => {

tests/unit/application/Context/State/Code/ApplicationCode.spec.ts

@@ -9,10 +9,10 @@ import { CodePosition } from '@/application/Context/State/Code/Position/CodePosi
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
 import { IUserScript } from '@/application/Context/State/Code/Generation/IUserScript';
-import { ScriptingDefinitionStub } from '../../../../stubs/ScriptingDefinitionStub';
-import { CategoryStub } from '../../../../stubs/CategoryStub';
-import { ScriptStub } from '../../../../stubs/ScriptStub';
-import { CategoryCollectionStub } from '../../../../stubs/CategoryCollectionStub';
+import { ScriptingDefinitionStub } from '@tests/unit/stubs/ScriptingDefinitionStub';
+import { CategoryStub } from '@tests/unit/stubs/CategoryStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
 
 describe('ApplicationCode', () => {
     describe('ctor', () => {

tests/unit/application/Context/State/Code/Event/CodeChangedEvent.spec.ts

@@ -4,8 +4,8 @@ import { CodeChangedEvent } from '@/application/Context/State/Code/Event/CodeCha
 import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
 import { CodePosition } from '@/application/Context/State/Code/Position/CodePosition';
-import { SelectedScriptStub } from '../../../../../stubs/SelectedScriptStub';
-import { ScriptStub } from '../../../../../stubs/ScriptStub';
+import { SelectedScriptStub } from '@tests/unit/stubs/SelectedScriptStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
 
 describe('CodeChangedEvent', () => {
     describe('ctor', () => {

tests/unit/application/Context/State/Code/Generation/CodeBuilderFactory.spec.ts

@@ -1,9 +1,8 @@
-import 'mocha';
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
 import { ShellBuilder } from '@/application/Context/State/Code/Generation/Languages/ShellBuilder';
 import { BatchBuilder } from '@/application/Context/State/Code/Generation/Languages/BatchBuilder';
 import { CodeBuilderFactory } from '@/application/Context/State/Code/Generation/CodeBuilderFactory';
-import { ScriptingLanguageFactoryTestRunner } from '../../../../Common/ScriptingLanguage/ScriptingLanguageFactoryTestRunner';
+import { ScriptingLanguageFactoryTestRunner } from '@tests/unit/application/Common/ScriptingLanguage/ScriptingLanguageFactoryTestRunner';
 
 describe('CodeBuilderFactory', () => {
     const sut = new CodeBuilderFactory();

tests/unit/application/Context/State/Code/Generation/UserScriptGenerator.spec.ts

@@ -4,8 +4,8 @@ import { UserScriptGenerator } from '@/application/Context/State/Code/Generation
 import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { ICodeBuilderFactory } from '@/application/Context/State/Code/Generation/ICodeBuilderFactory';
 import { ICodeBuilder } from '@/application/Context/State/Code/Generation/ICodeBuilder';
-import { ScriptStub } from '../../../../../stubs/ScriptStub';
-import { ScriptingDefinitionStub } from '../../../../../stubs/ScriptingDefinitionStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
+import { ScriptingDefinitionStub } from '@tests/unit/stubs/ScriptingDefinitionStub';
 
 describe('UserScriptGenerator', () => {
     describe('scriptingDefinition', () => {

tests/unit/application/Context/State/Code/Position/CodePosition.spec.ts

@@ -1,6 +1,6 @@
-import { CodePosition } from '@/application/Context/State/Code/Position/CodePosition';
 import 'mocha';
 import { expect } from 'chai';
+import { CodePosition } from '@/application/Context/State/Code/Position/CodePosition';
 
 describe('CodePosition', () => {
     describe('ctor', () => {

tests/unit/application/Context/State/Filter/FilterResult.spec.ts

@@ -1,8 +1,8 @@
-import { CategoryStub } from '../../../../stubs/CategoryStub';
-import { ScriptStub } from '../../../../stubs/ScriptStub';
-import { FilterResult } from '@/application/Context/State/Filter/FilterResult';
 import 'mocha';
 import { expect } from 'chai';
+import { FilterResult } from '@/application/Context/State/Filter/FilterResult';
+import { CategoryStub } from '@tests/unit/stubs/CategoryStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
 
 describe('FilterResult', () => {
     describe('hasAnyMatches', () => {

tests/unit/application/Context/State/Filter/UserFilter.spec.ts

@@ -1,11 +1,10 @@
-
 import 'mocha';
 import { expect } from 'chai';
 import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
 import { UserFilter } from '@/application/Context/State/Filter/UserFilter';
-import { CategoryStub } from '../../../../stubs/CategoryStub';
-import { ScriptStub } from '../../../../stubs/ScriptStub';
-import { CategoryCollectionStub } from '../../../../stubs/CategoryCollectionStub';
+import { CategoryStub } from '@tests/unit/stubs/CategoryStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
 
 describe('UserFilter', () => {
     describe('removeFilter', () => {

tests/unit/application/Context/State/Selection/SelectedScript.spec.ts

@@ -1,7 +1,7 @@
-import { ScriptStub } from '../../../../stubs/ScriptStub';
-import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import 'mocha';
 import { expect } from 'chai';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 
 describe('SelectedScript', () => {
     it('id is same as script id', () => {

tests/unit/application/Context/State/Selection/UserSelection.spec.ts

@@ -3,10 +3,10 @@ import { expect } from 'chai';
 import { IScript } from '@/domain/IScript';
 import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
 import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
-import { CategoryStub } from '../../../../stubs/CategoryStub';
-import { CategoryCollectionStub } from '../../../../stubs/CategoryCollectionStub';
-import { SelectedScriptStub } from '../../../../stubs/SelectedScriptStub';
-import { ScriptStub } from '../../../../stubs/ScriptStub';
+import { CategoryStub } from '@tests/unit/stubs/CategoryStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
+import { SelectedScriptStub } from '@tests/unit/stubs/SelectedScriptStub';
+import { ScriptStub } from '@tests/unit/stubs/ScriptStub';
 
 describe('UserSelection', () => {
     describe('ctor', () => {

tests/unit/application/Environment/BrowserOs/BrowserOsDetector.spec.ts

@@ -1,3 +1,4 @@
+import 'mocha';
 import { expect } from 'chai';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { BrowserOsDetector } from '@/application/Environment/BrowserOs/BrowserOsDetector';

tests/unit/application/Environment/Environment.spec.ts

@@ -1,8 +1,9 @@
+import 'mocha';
+import { expect } from 'chai';
 import { IBrowserOsDetector } from '@/application/Environment/BrowserOs/IBrowserOsDetector';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { DesktopOsTestCases } from './DesktopOsTestCases';
 import { Environment } from '@/application/Environment/Environment';
-import { expect } from 'chai';
 
 interface EnvironmentVariables {
     window?: any;

tests/unit/application/Parser/ApplicationParser.spec.ts

@@ -10,9 +10,9 @@ import { ProjectInformation } from '@/domain/ProjectInformation';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { getEnumValues } from '@/application/Common/Enum';
-import { CategoryCollectionStub } from '../../stubs/CategoryCollectionStub';
-import { getProcessEnvironmentStub } from '../../stubs/ProcessEnvironmentStub';
-import { CollectionDataStub } from '../../stubs/CollectionDataStub';
+import { CategoryCollectionStub } from '@tests/unit/stubs/CategoryCollectionStub';
+import { getProcessEnvironmentStub } from '@tests/unit/stubs/ProcessEnvironmentStub';
+import { CollectionDataStub } from '@tests/unit/stubs/CollectionDataStub';
 
 describe('ApplicationParser', () => {
     describe('parseApplication', () => {

tests/unit/application/Parser/CategoryCollectionParser.spec.ts

@@ -7,13 +7,13 @@ import { parseProjectInformation } from '@/application/Parser/ProjectInformation
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { RecommendationLevel } from '@/domain/RecommendationLevel';
 import { ScriptingDefinitionParser } from '@/application/Parser/ScriptingDefinition/ScriptingDefinitionParser';
-import { EnumParserStub } from '../../stubs/EnumParserStub';
-import { ProjectInformationStub } from '../../stubs/ProjectInformationStub';
-import { getCategoryStub, CollectionDataStub } from '../../stubs/CollectionDataStub';
-import { CategoryCollectionParseContextStub } from '../../stubs/CategoryCollectionParseContextStub';
-import { CategoryDataStub } from '../../stubs/CategoryDataStub';
-import { ScriptDataStub } from '../../stubs/ScriptDataStub';
-import { FunctionDataStub } from '../../stubs/FunctionDataStub';
+import { EnumParserStub } from '@tests/unit/stubs/EnumParserStub';
+import { ProjectInformationStub } from '@tests/unit/stubs/ProjectInformationStub';
+import { getCategoryStub, CollectionDataStub } from '@tests/unit/stubs/CollectionDataStub';
+import { CategoryCollectionParseContextStub } from '@tests/unit/stubs/CategoryCollectionParseContextStub';
+import { CategoryDataStub } from '@tests/unit/stubs/CategoryDataStub';
+import { ScriptDataStub } from '@tests/unit/stubs/ScriptDataStub';
+import { FunctionDataStub } from '@tests/unit/stubs/FunctionDataStub';
 
 describe('CategoryCollectionParser', () => {
     describe('parseCategoryCollection', () => {

tests/unit/application/Parser/CategoryParser.spec.ts

@@ -3,11 +3,11 @@ import { expect } from 'chai';
 import { parseCategory } from '@/application/Parser/CategoryParser';
 import { parseScript } from '@/application/Parser/Script/ScriptParser';
 import { parseDocUrls } from '@/application/Parser/DocumentationParser';
-import { ScriptCompilerStub } from '../../stubs/ScriptCompilerStub';
-import { ScriptDataStub } from '../../stubs/ScriptDataStub';
-import { CategoryCollectionParseContextStub } from '../../stubs/CategoryCollectionParseContextStub';
-import { LanguageSyntaxStub } from '../../stubs/LanguageSyntaxStub';
-import { CategoryDataStub } from '../../stubs/CategoryDataStub';
+import { ScriptCompilerStub } from '@tests/unit/stubs/ScriptCompilerStub';
+import { ScriptDataStub } from '@tests/unit/stubs/ScriptDataStub';
+import { CategoryCollectionParseContextStub } from '@tests/unit/stubs/CategoryCollectionParseContextStub';
+import { LanguageSyntaxStub } from '@tests/unit/stubs/LanguageSyntaxStub';
+import { CategoryDataStub } from '@tests/unit/stubs/CategoryDataStub';
 
 describe('CategoryParser', () => {
     describe('parseCategory', () => {

tests/unit/application/Parser/ProjectInformationParser.spec.ts

@@ -1,7 +1,7 @@
 import 'mocha';
 import { expect } from 'chai';
 import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
-import { getProcessEnvironmentStub } from '../../stubs/ProcessEnvironmentStub';
+import { getProcessEnvironmentStub } from '@tests/unit/stubs/ProcessEnvironmentStub';
 
 describe('ProjectInformationParser', () => {
     describe('parseProjectInformation', () => {

tests/unit/application/Parser/Script/CategoryCollectionParseContext.spec.ts

@@ -1,14 +1,14 @@
 import 'mocha';
 import { expect } from 'chai';
+import { FunctionData } from 'js-yaml-loader!@/*';
 import { ISyntaxFactory } from '@/application/Parser/Script/Syntax/ISyntaxFactory';
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
-import { LanguageSyntaxStub } from '../../../stubs/LanguageSyntaxStub';
 import { CategoryCollectionParseContext } from '@/application/Parser/Script/CategoryCollectionParseContext';
-import { ScriptingDefinitionStub } from '../../../stubs/ScriptingDefinitionStub';
-import { FunctionDataStub } from '../../../stubs/FunctionDataStub';
 import { ILanguageSyntax } from '@/domain/ScriptCode';
 import { ScriptCompiler } from '@/application/Parser/Script/Compiler/ScriptCompiler';
-import { FunctionData } from 'js-yaml-loader!*';
+import { LanguageSyntaxStub } from '@tests/unit/stubs/LanguageSyntaxStub';
+import { ScriptingDefinitionStub } from '@tests/unit/stubs/ScriptingDefinitionStub';
+import { FunctionDataStub } from '@tests/unit/stubs/FunctionDataStub';
 
 describe('CategoryCollectionParseContext', () => {
     describe('ctor', () => {

tests/unit/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler.spec.ts

@@ -2,8 +2,8 @@ import 'mocha';
 import { expect } from 'chai';
 import { ExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler';
 import { IExpressionParser } from '@/application/Parser/Script/Compiler/Expressions/Parser/IExpressionParser';
-import { ExpressionStub } from '../../../../../stubs/ExpressionStub';
-import { ExpressionParserStub } from '../../../../../stubs/ExpressionParserStub';
+import { ExpressionStub } from '@tests/unit/stubs/ExpressionStub';
+import { ExpressionParserStub } from '@tests/unit/stubs/ExpressionParserStub';
 
 describe('ExpressionsCompiler', () => {
     describe('compileExpressions', () => {

tests/unit/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.spec.ts

@@ -3,7 +3,7 @@ import { expect } from 'chai';
 import { IExpression } from '@/application/Parser/Script/Compiler/Expressions/Expression/IExpression';
 import { IExpressionParser } from '@/application/Parser/Script/Compiler/Expressions/Parser/IExpressionParser';
 import { CompositeExpressionParser } from '@/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser';
-import { ExpressionStub } from '../../../../../../stubs/ExpressionStub';
+import { ExpressionStub } from '@tests/unit/stubs/ExpressionStub';
 
 describe('CompositeExpressionParser', () => {
     describe('ctor', () => {