Update the PDK scripts

Author: nabeelio

gulpfile.mjs

@@ -8,10 +8,9 @@ import minify from 'gulp-minify'
 
 dotconfig.config()
 
-// console.log(process.env)
-
 /**
  * Different paths we use...
+ * Don't modify this directly, use the environment variables
  */
 const paths = {
   src: './src',
@@ -24,12 +23,66 @@ const paths = {
   acars: process.env.ACARS_SCRIPTS_PATH,
 }
 
+/**
+ * Build the project, copy the appropriate files over
+ * @public
+ */
+export const build = series(buildTsTask, copyPackageTask)
+
+/**
+ * Build a distribution zip file, which can be easily uploaded
+ * @public
+ */
+export const dist = series(
+  build,
+  buildZipTask,
+)
+
+/**
+ * Watch the files and distribute them to the
+ * documents/vmsacars/data/<profile>/config directory
+ * @public
+ */
+export const local = localTask
+
+
+/**
+ * The default action
+ * @default
+ * @public
+ */
+export default build
+
+
+/**
+ * The build steps that run from the csproj
+ * Force the output path to go into our build directory
+ * @internal
+ */
+export const csbuild = series(
+  async () => {
+    paths.acars = '../Content/config/default'
+  },
+  build,
+  copyFilesToScriptsPathTask,
+)
+
+/**
+ *
+ *
+ *
+ */
+
 /**
  * Configure the ts transpilation
  */
 const tsProject = ts.createProject('tsconfig.json')
 
-function build_ts() {
+/**
+ * Build the Typescript files
+ * @returns {module:stream.Stream.Transform | *}
+ */
+async function buildTsTask() {
   let pipeline = tsProject.src()
     .pipe(eslint())
     .pipe(eslint.failAfterError())
@@ -43,7 +96,8 @@ function build_ts() {
     mangle: false,
   }))*/
 
-  pipeline = pipeline.pipe(dest(paths.dist))
+  pipeline = pipeline
+    .pipe(dest(paths.dist))
 
   return pipeline
 }
@@ -52,120 +106,65 @@ function build_ts() {
  *
  * @returns {*}
  */
-function copy_package() {
+async function copyPackageTask() {
   return src([paths.src + '/package.json'])
     .pipe(dest(paths.dist))
 }
 
-/**
- * Build the project, copy the appropriate files over
- */
-export const build = series(build_ts, copy_package)
-
 /**
  * Copy the files from dist into ACARS_SCRIPTS_PATH
  *
  */
-export function copy() {
+export async function copyFilesToScriptsPathTask() {
   console.log(`Copying files to ${paths.acars}`)
 
-  return src(['./**/*', '!node_modules/**/*'], { 'cwd': paths.dist })
+  return src(
+    [
+      './**/*',
+      '!node_modules/**/*',
+    ],
+    { 'cwd': paths.dist },
+  )
     .pipe(dest(paths.acars))
 }
 
-/**
- * The build steps that run from the csproj
- * Force the output path to go into our build directory
- */
-export const csbuild = series(
-  async () => {
-    paths.acars = '../Content/config/default'
-  },
-  build,
-  copy,
-)
 
 /**
  * TODO: Build the distribution zip file
  */
-function build_dist() {
+function buildZipTask() {
 
 }
 
-/**
- * Build a distribution zip file, which can be easily uploaded
- */
-export const dist = series(
-  build,
-  build_dist,
-)
 
 /**
  * Watch the src folder for updates, compile them and then copy them
  * to the config directory. ACARS should auto-reload
  */
-export async function testing() {
+export async function testingTask() {
   watch('src/', {
     ignoreInitial: false,
     delay: 500,
-  }, series(build, copy))
+  }, series(build, copyFilesToScriptsPathTask))
 }
 
 /**
- * Watch the files and distribute them out
+ * Watch the files and then build and copy them to the documents directory
  */
-export function watchFiles() {
-  watch('src/', build)
+export async function localTask() {
+  return watch('src/', { ignoreInitial: false }, series(build, copyFilesToScriptsPathTask), function() {
+    cb()
+  })
 }
 
-export { watchFiles as watch }
-
 /**
  * Clean up the /dest directory
  */
-export async function clean() {
+export async function cleanTask() {
   try {
     await deleteAsync([paths.dist])
     await Promise.resolve()
   } catch (e) {
     console.log(e)
   }
 }
-
-/**
- * The default action
- */
-export default build
-
-/**
- * Get the default profile name
- *
- * @returns {*}
- */
-/*async function getDefaultProfilePath() {
-    if (profileName === null || profileName === '') {
-        const f = await fs.promises.readFile(`${paths.acars}/settings.json`)
-        const settings = JSON.parse(f)
-        profileName = settings.Profile
-        console.log('No profile name set, looked in settings and used ' + profileName)
-    }
-
-    // Read all of the profiles
-    let dirent
-    const dir = await fs.promises.opendir(`${paths.acars}/profiles`)
-    for await (const dirent of dir) {
-        const pf = await fs.promises.readFile(`${dirent.parentPath}/${dirent.name}`)
-        if (pf === null) {
-            continue
-        }
-
-        const profile = JSON.parse(pf)
-        console.log(profile)
-
-        if (profile.Name === profileName) {
-            return `${paths.acars}/data/${profile.Domain}/config/`
-        }
-    }
-
-    return null
-}*/

package-lock.json

@@ -13,7 +13,7 @@
     "lint": "eslint --fix",
     "format": "prettier --ignore-path .gitignore --write \"src/**/*.+(js|ts)\"",
     "testing": "gulp testing",
-    "watch": "gulp watch"
+    "local": "gulp local"
   },
   "keywords": [],
   "author": "Nabeel Shahzad <[email protected]>",
@@ -32,6 +32,7 @@
     "gulp-minify": "^3.1.0",
     "gulp-prettier": "^6.0.0",
     "gulp-typescript": "^6.0.0-alpha.1",
+    "gulplog": "^2.2.0",
     "merge2": "^1.4.1",
     "prettier": "^3.3.3",
     "typescript": "^5.5.4"

package.json

@@ -19,7 +19,7 @@ export enum GateType {
   /** Added for MSFS */
   Gate_Extra = 15,
   /** Added for MSFS */
-  Jetway = 16,
+  Jetway = 16
 }
 /** The runway/taxiway surface */
 export enum Surface {
@@ -47,13 +47,13 @@ export enum Surface {
   Sand = 21,
   Shale = 22,
   Tarmac = 23,
-  Unknown = 99999,
+  Unknown = 99999
 }
 export enum AircraftType {
   Airliner = 0,
   Cargo = 1,
   GeneralAviation = 2,
-  Helicopter = 3,
+  Helicopter = 3
 }
 /** The type of engine */
 export enum EngineType {
@@ -62,7 +62,7 @@ export enum EngineType {
   None = 2,
   Helo = 3,
   Rocket = 4,
-  Turboprop = 5,
+  Turboprop = 5
 }
 export enum SimType {
   None = 0,
@@ -75,13 +75,13 @@ export enum SimType {
   /** Specifically only for MSFS 2020 */
   FlightSimulator2020 = 6,
   /** Specifically only for MSFS 2024 */
-  FlightSimulator2024 = 7,
+  FlightSimulator2024 = 7
 }
 export enum FareType {
   /** Primarily a passenger flight */
   Passenger = 0,
   /** Primarily a cargo flight */
-  Cargo = 1,
+  Cargo = 1
 }
 /** The different types of flight plans that can be parsed */
 export enum FlightPlanType {
@@ -94,7 +94,7 @@ export enum FlightPlanType {
   /** Flightplan was created using SimBrief */
   SimBrief = 3,
   /** Flightplan was create using Flight Simulator */
-  MsFs = 4,
+  MsFs = 4
 }
 /** The PIREP states - these match the phase */
 export enum PirepState {
@@ -131,7 +131,7 @@ export enum PirepState {
   /** The aircraft is on block at the gate */
   OnBlock = 15,
   /** The aircraft is climbing to its cruise altitude */
-  InitialClimb = 16,
+  InitialClimb = 16
 }
 /** The simtype for the rule file */
 export enum AircraftConfigSimType {
@@ -142,7 +142,7 @@ export enum AircraftConfigSimType {
   /** Configuration for MSFS 2020 *only* */
   MsFs20 = 3,
   /** Configuration for MSFS 2024 *only* */
-  MsFs24 = 4,
+  MsFs24 = 4
 }
 /** Features of an aircraft. They are binary on or off */
 export enum AircraftFeature {
@@ -166,7 +166,7 @@ export enum AircraftFeature {
   Transponder = 17,
   LandingGear = 18,
   Autopilot = 19,
-  ExternalPower = 20,
+  ExternalPower = 20
 }
 /** The type of the dataref */
 export enum FeatureType {
@@ -177,5 +177,5 @@ export enum FeatureType {
   /** An array of integers */
   IntArray = 3,
   /** An array of numbers */
-  NumberArray = 4,
+  NumberArray = 4
 }