feat: add vendor id

watson · Nov 12, 2024 · 81fd993 · 81fd993
1 parent 2a6f8e6
commit 81fd993
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 0 deletions.
diff --git a/create-typings.js b/create-typings.js
@@ -31,7 +31,13 @@ export const isPR: boolean | null;
  * to use \`ci.TRAVIS\` instead.
  */
 export const name: string | null;
+/**
+ * Returns a string containing the identifier of the CI server the code is running on. If
+ * CI server is not detected, it returns \`null\`.
+ */
+export const id: string | null;
 
+/* Vendor constants */
 `
 
   for (const { constant } of vendors) {

diff --git a/index.d.ts b/index.d.ts
@@ -25,7 +25,13 @@ export const isPR: boolean | null;
  * to use `ci.TRAVIS` instead.
  */
 export const name: string | null;
+/**
+ * Returns a string containing the identifier of the CI server the code is running on. If
+ * CI server is not detected, it returns `null`.
+ */
+export const id: string | null;
 
+/* Vendor constants */
 export const AGOLA: boolean;
 export const APPCIRCLE: boolean;
 export const APPVEYOR: boolean;

diff --git a/index.js b/index.js
@@ -13,6 +13,7 @@ Object.defineProperty(exports, '_vendors', {
 
 exports.name = null
 exports.isPR = null
+exports.id = null
 
 vendors.forEach(function (vendor) {
   const envs = Array.isArray(vendor.env) ? vendor.env : [vendor.env]
@@ -28,6 +29,7 @@ vendors.forEach(function (vendor) {
 
   exports.name = vendor.name
   exports.isPR = checkPR(vendor)
+  exports.id = vendor.constant
 })
 
 exports.isCI = !!(