@awdware/gah-shared - npm Package Compare versions

Comparing version 0.2.5 to 0.4.0

assets/gah-config-schema.json

@@ -8,2 +8,6 @@ {
         },
+        "extends": {
+            "description": "The path to the config file which this config file extends",
+            "type": "string"
+        },
         "plugins": {
@@ -16,5 +20,16 @@ "description": "The array of plugins used in this project. Often only used for the host, but also possible in 'normal' modules.",
         },
-        "skipTsConfigPathsAdjustments": {
-            "description": "If this property is set to true, gah will not adjust the paths object in the tsconfig json of the module(s) in this folder.",
-            "type": "boolean"
+        "precompiled": {
+            "description": "List of precompiled modules with a path to the tgz file (output from yarn pack command)",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string"
+                    },
+                    "path": {
+                        "type": "string"
+                    }
+                }
+            }
         }
@@ -21,0 +36,0 @@ },

assets/gah-module-schema.json

@@ -78,2 +78,6 @@ {
                     }
+                },
+                "config": {
+                    "description": "Configure plugins and other settings for this module.",
+                    "$ref": "#/definitions/GahConfig"
                 }
@@ -102,2 +106,64 @@ }
             }
+        },
+        "GahConfig": {
+            "type": "object",
+            "properties": {
+                "$schema": {
+                    "type": "string",
+                    "default": "https://raw.githubusercontent.com/awdware/gah/master/shared/assets/gah-config-schema.json"
+                },
+                "extends": {
+                    "description": "The path to the config file which this config file extends",
+                    "type": "string"
+                },
+                "plugins": {
+                    "description": "The array of plugins used in this project. Often only used for the host, but also possible in 'normal' modules.",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/GahPluginDependencyConfig"
+                    }
+                },
+                "precompiled": {
+                    "description": "List of precompiled modules with a path to the tgz file (output from yarn pack command)",
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "name": {
+                                "type": "string"
+                            },
+                            "path": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "GahPluginDependencyConfig": {
+            "description": "Describes a plugin dependency",
+            "type": "object",
+            "properties": {
+                "name": {
+                    "description": "The name of the plugin that should be used. This has to be the name of a npm package.",
+                    "type": "string"
+                },
+                "settings": {
+                    "$ref": "#/definitions/GahPluginConfig",
+                    "description": "The configuration for the plugin. Plugins add their own properties, please look at the documentation for the used plugin to see which settings are available."
+                },
+                "version": {
+                    "description": "The version of the plugin that should be used.",
+                    "type": "string"
+                }
+            }
+        },
+        "GahPluginConfig": {
+            "additionalProperties": true,
+            "type": "object",
+            "properties": {
+                "enabled": {
+                    "type": "boolean"
+                }
+            }
         }
@@ -104,0 +170,0 @@ },

lib/index.d.ts

@@ -14,3 +14,2 @@ export * from './models/gah-angular-compiler-options';
 export * from './models/global-gah-data';
-export * from './models/gah-local-config';
 export * from './models/gah-plugin';
@@ -17,0 +16,0 @@ export * from './models/module-definition';

lib/index.js

@@ -26,3 +26,2 @@ "use strict";
 __exportStar(require("./models/global-gah-data"), exports);
-__exportStar(require("./models/gah-local-config"), exports);
 __exportStar(require("./models/gah-plugin"), exports);
@@ -29,0 +28,0 @@ __exportStar(require("./models/module-definition"), exports);

lib/models/gah-config.d.ts

@@ -5,2 +5,6 @@ import { GahPluginDependencyConfig } from './gah-plugin-dependency-config';
     /**
+     * The path to the config file which this config file extends
+     */
+    extends?: string;
+    /**
      * The array of plugins used in this project. Often only used for the host, but also possible in 'normal' modules.
@@ -10,6 +14,9 @@ */
     /**
-     * If this property is set to true, gah will not adjust the paths object in the tsconfig json of the module(s) in this folder.
+     * List of precompiled modules with a path to the tgz file (output from yarn pack command)
      */
-    skipTsConfigPathsAdjustments: boolean;
+    precompiled?: {
+        name: string;
+        path?: string;
+    }[];
     constructor();
 }

lib/models/gah-context.d.ts

@@ -9,2 +9,3 @@ export interface GahContext {
     yarnTimeout?: number;
+    configName?: string;
 }

lib/models/module-definition.d.ts

@@ -0,1 +1,2 @@
+import { GahConfig } from './gah-config';
 import { ModuleReference } from './module-reference';
@@ -43,2 +44,6 @@ export declare class ModuleDefinition {
     excludedPackages?: string[];
+    /**
+     * Configure plugins and other settings for this module.
+     */
+    config?: GahConfig;
 }

lib/services/configuration.service.d.ts

@@ -6,6 +6,6 @@ import { GahConfig } from '../models/gah-config';
 import { GahModuleType } from '../models/gah-module-type';
-import { GahLocalConfig } from '../models/gah-local-config';
 export interface IConfigurationService {
     gahConfigExists(): boolean;
-    getGahConfig(forceLoad?: boolean): GahConfig;
+    getGahConfig(): GahConfig;
+    getPartialGahConfig(): GahConfig;
     getGahModule(forceLoad?: boolean): GahModule;
@@ -23,3 +23,2 @@ getGahHost(forceLoad?: boolean): GahHost;
     externalConfig: GahModule;
-    localConfig(): GahLocalConfig | undefined;
 }

package.json

 {
   "name": "@awdware/gah-shared",
-  "version": "0.2.5",
+  "version": "0.4.0",
   "description": "Provides types and interfaces for gah",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

type-compat/ts3.4/index.d.ts

@@ -14,3 +14,2 @@ export * from './models/gah-angular-compiler-options';
 export * from './models/global-gah-data';
-export * from './models/gah-local-config';
 export * from './models/gah-plugin';
@@ -17,0 +16,0 @@ export * from './models/module-definition';

type-compat/ts3.4/models/gah-config.d.ts

@@ -5,2 +5,6 @@ import { GahPluginDependencyConfig } from './gah-plugin-dependency-config';
     /**
+     * The path to the config file which this config file extends
+     */
+    extends?: string;
+    /**
      * The array of plugins used in this project. Often only used for the host, but also possible in 'normal' modules.
@@ -10,6 +14,9 @@ */
     /**
-     * If this property is set to true, gah will not adjust the paths object in the tsconfig json of the module(s) in this folder.
+     * List of precompiled modules with a path to the tgz file (output from yarn pack command)
      */
-    skipTsConfigPathsAdjustments: boolean;
+    precompiled?: {
+        name: string;
+        path?: string;
+    }[];
     constructor();
 }

type-compat/ts3.4/models/gah-context.d.ts

@@ -9,2 +9,3 @@ export interface GahContext {
     yarnTimeout?: number;
+    configName?: string;
 }

type-compat/ts3.4/models/module-definition.d.ts

@@ -0,1 +1,2 @@
+import { GahConfig } from './gah-config';
 import { ModuleReference } from './module-reference';
@@ -43,2 +44,6 @@ export declare class ModuleDefinition {
     excludedPackages?: string[];
+    /**
+     * Configure plugins and other settings for this module.
+     */
+    config?: GahConfig;
 }

type-compat/ts3.4/services/configuration.service.d.ts

@@ -6,6 +6,6 @@ import { GahConfig } from '../models/gah-config';
 import { GahModuleType } from '../models/gah-module-type';
-import { GahLocalConfig } from '../models/gah-local-config';
 export interface IConfigurationService {
     gahConfigExists(): boolean;
-    getGahConfig(forceLoad?: boolean): GahConfig;
+    getGahConfig(): GahConfig;
+    getPartialGahConfig(): GahConfig;
     getGahModule(forceLoad?: boolean): GahModule;
@@ -23,3 +23,2 @@ getGahHost(forceLoad?: boolean): GahHost;
     externalConfig: GahModule;
-    localConfig(): GahLocalConfig | undefined;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

107175

increased by2.73%

Lines of code

2582

increased by3.36%

Worsened metrics

Number of package files

161

decreased by-2.42%

No dependency changes