@ng-doc/builder 18.2.0 → 18.3.1

package/helpers/repo-link.d.ts

@@ -8,7 +8,7 @@ import { NgDocRepoConfig } from '../interfaces';
  * @param scope
  * @param lineNumber
  */
-export declare function editFileInRepoUrl({ url, mainBranch }: NgDocRepoConfig, filePath: string, scope: string, lineNumber?: number): string;
+export declare function editFileInRepoUrl({ url, mainBranch, platform }: NgDocRepoConfig, filePath: string, scope: string, lineNumber?: number): string;
 /**
  *
  * @param repoConfig
@@ -17,4 +17,4 @@ export declare function editFileInRepoUrl({ url, mainBranch }: NgDocRepoConfig,
  * @param filePath
  * @param lineNumber
  */
-export declare function viewFileInRepoUrl({ url, releaseBranch }: NgDocRepoConfig, filePath: string, lineNumber?: number): string;
+export declare function viewFileInRepoUrl({ url, releaseBranch, platform }: NgDocRepoConfig, filePath: string, lineNumber?: number): string;

package/helpers/repo-link.js

@@ -12,11 +12,18 @@ const posix_1 = require("./posix");
  * @param scope
  * @param lineNumber
  */
-function editFileInRepoUrl({ url, mainBranch }, filePath, scope, lineNumber) {
+function editFileInRepoUrl({ url, mainBranch, platform = 'github' }, filePath, scope, lineNumber) {
     if (url && mainBranch) {
         const rUrl = url.replace(/\/$/, '');
         const fPath = (0, posix_1.posix)(filePath).replace(/^\//, '');
-        return `${rUrl}/edit/${mainBranch}/${fPath}?message=docs(${scope}): describe your changes here...${lineNumber ? `#L${lineNumber}` : ''}`;
+        let editUrl = '';
+        if (platform === 'github') {
+            editUrl = `${rUrl}/edit/${mainBranch}/${fPath}?message=docs(${scope}): describe your changes here...${lineNumber ? `#L${lineNumber}` : ''}`;
+        }
+        else if (platform === 'gitlab') {
+            editUrl = `${rUrl}/-/edit/${mainBranch}/${fPath}?message=docs(${scope}): describe your changes here...${lineNumber ? `#L${lineNumber}` : ''}`;
+        }
+        return editUrl;
     }
     return filePath;
 }
@@ -28,11 +35,18 @@ function editFileInRepoUrl({ url, mainBranch }, filePath, scope, lineNumber) {
  * @param filePath
  * @param lineNumber
  */
-function viewFileInRepoUrl({ url, releaseBranch }, filePath, lineNumber) {
+function viewFileInRepoUrl({ url, releaseBranch, platform = 'github' }, filePath, lineNumber) {
     if (url && releaseBranch) {
         const rUrl = url.replace(/\/$/, '');
         const fPath = (0, posix_1.posix)(filePath).replace(/^\//, '');
-        return `${rUrl}/blob/${releaseBranch}/${fPath}${lineNumber ? `#L${lineNumber}` : ''}`;
+        let viewUrl = '';
+        if (platform === 'github') {
+            viewUrl = `${rUrl}/blob/${releaseBranch}/${fPath}${lineNumber ? `#L${lineNumber}` : ''}`;
+        }
+        else if (platform === 'gitlab') {
+            viewUrl = `${rUrl}/-/blob/${releaseBranch}/${fPath}${lineNumber ? `#L${lineNumber}` : ''}`;
+        }
+        return viewUrl;
     }
     return filePath;
 }

package/helpers/repo-link.js.map

@@ -1 +1 @@
-{"version":3,"file":"repo-link.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/repo-link.ts"],"names":[],"mappings":";;AAYA,8CAgBC;AAUD,8CAaC;AAlDD,mCAAgC;AAEhC;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAChC,EAAE,GAAG,EAAE,UAAU,EAAmB,EACpC,QAAgB,EAChB,KAAa,EACb,UAAmB;IAEnB,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEjD,OAAO,GAAG,IAAI,SAAS,UAAU,IAAI,KAAK,iBAAiB,KAAK,mCAC/D,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EAClC,EAAE,CAAC;IACJ,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAChC,EAAE,GAAG,EAAE,aAAa,EAAmB,EACvC,QAAgB,EAChB,UAAmB;IAEnB,IAAI,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEjD,OAAO,GAAG,IAAI,SAAS,aAAa,IAAI,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACvF,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC"}
+{"version":3,"file":"repo-link.js","sourceRoot":"","sources":["../../../../libs/builder/helpers/repo-link.ts"],"names":[],"mappings":";;AAYA,8CAyBC;AAUD,8CAoBC;AAlED,mCAAgC;AAEhC;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAC7B,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,GAAG,QAAQ,EAAmB,EACzD,QAAgB,EAChB,KAAa,EACb,UAAmB;IAEnB,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,GAAG,GAAG,IAAI,SAAS,UAAU,IAAI,KAAK,iBAAiB,KAAK,mCAC/D,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EACrC,EAAE,CAAC;QACP,CAAC;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,GAAG,GAAG,IAAI,WAAW,UAAU,IAAI,KAAK,iBAAiB,KAAK,mCACjE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EACrC,EAAE,CAAC;QACP,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC7B,EAAE,GAAG,EAAE,aAAa,EAAE,QAAQ,GAAG,QAAQ,EAAmB,EAC5D,QAAgB,EAChB,UAAmB;IAEnB,IAAI,GAAG,IAAI,aAAa,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,GAAG,GAAG,IAAI,SAAS,aAAa,IAAI,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC7F,CAAC;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,GAAG,GAAG,IAAI,WAAW,aAAa,IAAI,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC/F,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC"}

package/interfaces/repo-config.d.ts

@@ -1,3 +1,4 @@
+import { NgDocPlatform } from '../types';
 /**
  * The repository configuration interface.
  */
@@ -14,4 +15,8 @@ export interface NgDocRepoConfig {
      * The release branch name (e.g. "release"), uses to generate correct links for the "View source" button
      */
     releaseBranch: string;
+    /**
+     * The platform name (e.g. "github"/"gitlab")
+     */
+    platform?: NgDocPlatform;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/builder",
-  "version": "18.2.0",
+  "version": "18.3.1",
   "type": "commonjs",
   "builders": "./builders.json",
   "schematics": "./schematics/collection.json",
@@ -11,10 +11,10 @@
     ]
   },
   "dependencies": {
-    "@ng-doc/core": "18.2.0",
-    "@ng-doc/utils": "18.2.0",
-    "@angular-devkit/architect": ">=0.1801.0",
-    "@angular-devkit/build-angular": ">=18.1.0",
+    "@ng-doc/core": "18.3.1",
+    "@ng-doc/utils": "18.3.1",
+    "@angular-devkit/architect": ">=0.1801.0 < 0.1900.0",
+    "@angular-devkit/build-angular": ">= 18.1.0 < 19.0.0",
     "chokidar": "3.5.3",
     "minimatch": "9.0.1",
     "rxjs": "^7.0.0",

package/types/index.d.ts

@@ -3,3 +3,4 @@ export * from './artifact-processor';
 export * from './component-asset';
 export * from './constructable';
 export * from './supported-declaration';
+export * from './supported-platforms';

package/types/index.js

@@ -6,4 +6,5 @@ tslib_1.__exportStar(require("./artifact-processor"), exports);
 tslib_1.__exportStar(require("./component-asset"), exports);
 tslib_1.__exportStar(require("./constructable"), exports);
 tslib_1.__exportStar(require("./supported-declaration"), exports);
+tslib_1.__exportStar(require("./supported-platforms"), exports);
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/types/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,+DAAqC;AACrC,4DAAkC;AAClC,0DAAgC;AAChC,kEAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/builder/types/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,+DAAqC;AACrC,4DAAkC;AAClC,0DAAgC;AAChC,kEAAwC;AACxC,gEAAsC"}

package/types/supported-platforms.d.ts

@@ -0,0 +1 @@
+export type NgDocPlatform = 'github' | 'gitlab';

package/types/supported-platforms.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=supported-platforms.js.map

package/types/supported-platforms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"supported-platforms.js","sourceRoot":"","sources":["../../../../libs/builder/types/supported-platforms.ts"],"names":[],"mappings":""}