Rename gulp local to dev

Author: nabeelio

README.md

@@ -59,26 +59,35 @@ npm run build
 
 This doesn't copy it anywhere, just runs a compile and build
 
-### Create a distribution file
-
-This creates a `dist.zip` (you can rename it in the `.env` file) after running a compile.
-You can modify the `gulpfile.mjs` to include other files in the `dist/` directory - this
-directory is simply zipped and placed into the `dist/` directory. You can then configure
-Github Actions to then upload this zip somewhere for ACARS to download.
-
 #### Automatically build and copy to ACARS
 
-This will setup a watch, and then automatically transpile and then copy the contents of the
-`dist` folder into the `ACARS_PROFILE_PATH` directory that's defined in the `.env` file.
+This will setup a watch, and then automatically transpile and then copy the
+contents of the
+`dist` folder into the `ACARS_PROFILE_PATH` directory that's defined in the
+`.env` file.
 
 ```shell
 npm run dev
 ```
 
+### Create a distribution file
+
+Running:
+
+```shell
+npm run dist
+```
+
+Creates a `dist.zip` (you can rename it in the `.env` file) after running a
+compile. You can modify the `gulpfile.mjs` to include other files - by default,
+anything in the `dist` directory gets packaged. You can then configure
+Github Actions to then upload this zip somewhere for ACARS to download.
+
 ### Disable Downloading Latest Defaults
 
-Sometimes, it's just useful to disable downloading of the latest defaults, and just edit the scripts that are included
-to see how they work. To do that, create a file in your `Documents/vmsacars` directory, called `appsettings.local.json`,
+Sometimes, it's just useful to disable downloading of the latest defaults, and
+just edit the scripts that are included to see how they work. To do that, create
+a file in your `Documents/vmsacars` directory, called `appsettings.local.json`,
 and place the following:
 
 ```json filename="appsettings.local.json"
@@ -96,7 +105,8 @@ and place the following:
 }
 ```
 
-You can also adjust the log level to "Information", "Debug" or "Verbose" ("Debug" is recommended)
+You can also adjust the log level to "Information", "Debug" or "Verbose"
+("Debug" is recommended)
 
 ---
 
@@ -106,8 +116,8 @@ There are several core files/interfaces that are included:
 
 ### `src/global.d.ts`
 
-This describes the globally available functions, including the logging methods available through `console` and
-`Acars`.
+This describes the globally available functions, including the logging methods
+available through `console` and `Acars`.
 
 ### `src/types.d.ts`
 
@@ -117,13 +127,15 @@ This contains all of the base types:
 - `Telemetry` - telemetry information that's come out of the simulator
 - `User` - information about the current user
 
-It also includes other detailed type information, for example `Length`, so you can retrieve that type of information.
+It also includes other detailed type information, for example `Length`, so you
+can retrieve that type of information.
 
 ---
 
 ## Aircraft Configuration:
 
-Aircraft rules are required to inherit the `AircraftConfig` abstract class. An example class would look like:
+Aircraft rules are required to inherit the `AircraftConfig` abstract class. An
+example class would look like:
 
 ```typescript
 import { AircraftConfigSimType, AircraftFeature, FeatureType } from '../defs'
@@ -175,9 +187,12 @@ The configuration is a class which has a few different components.
       - `AircraftConfigSimType.MsFs20`
       - `AircraftConfigSimType.MsFs24`
     - `enabled`
-    - `priority` - from 1 (lowest) to 10 (highest). If there are multiple rules which match this, then which one takes
-      priority. All the built-in rules are at a priority 1, and aircraft specifics rules are priority 2. I recommend
-      using a priority of 3 or higher. More on this below
+      - `priority` - from 1 (lowest) to 10 (highest).
+        - If there are multiple rules that match this, then which one takes
+          priority.
+        - All the built-in rules are at a priority 1
+        - Aircraft specifics rules are priority 2.
+        - I recommend using a priority of 3 or higher. More on this below
 2. `features` - this is the type `FeatureAddresses` - see `defs.ts` for the definitions
     - MSFS - the lookups you enter are LVars
     - X-Plane - the looks ups are via datarefs
@@ -193,16 +208,18 @@ The configuration is a class which has a few different components.
 5. Methods for the different features (see below)
     - The maps - a group of datarefs or offsets which constitute that feature being "on" or "enabled"
 
-In the above example, for the Fenix A320, the landing lights are controlled by two datarefs, both of which the
-values need to be 1 or 2 for the landing lights to be considered "on".
+In the above example, for the Fenix A320, the landing lights are controlled by
+two datarefs, both of which the values need to be 1 or 2 for the landing lights
+to be considered "on".
 
 #### Targeting MSFS
 
 There are 3 possible values for targetting MSFS in the configs:
 
-    - `AircraftConfigSimType.MsFs` - This will apply the configuration to both 2020 and 2024
-    - `AircraftConfigSimType.MsFs20` - This will be for 2020 ONLY
-    - `AircraftConfigSimType.MsFs24` - This will be for 2024 ONLY
+- `AircraftConfigSimType.MsFs` - This will apply the configuration to both 2020
+  and 2024
+- `AircraftConfigSimType.MsFs20` - This will be for 2020 ONLY
+- `AircraftConfigSimType.MsFs24` - This will be for 2024 ONLY
 
 ### Features
 

gulpfile.mjs

@@ -1,13 +1,11 @@
 import dotconfig from '@dotenvx/dotenvx'
 import { deleteSync as del } from 'del'
+import fs from 'fs'
 import { dest, series, src, watch } from 'gulp'
 import eslint from 'gulp-eslint-new'
-import ts from 'gulp-typescript'
 import prettier from 'gulp-prettier'
+import ts from 'gulp-typescript'
 import zip from 'gulp-zip'
-import tap from 'gulp-tap'
-import minify from 'gulp-minify'
-import fs from 'fs'
 
 dotconfig.config()
 
@@ -57,7 +55,7 @@ export const dist = series(
  * documents/vmsacars/data/<profile>/config directory
  * @public
  */
-export const local = localBuildTask
+export const dev = localBuildTask
 
 /**
  * The build steps that run from the csproj

package.json

@@ -9,11 +9,12 @@
     "clean": "gulp clean",
     "copy": "gulp copy",
     "csbuild": "gulp csbuild",
+    "dev": "gulp dev",
     "dist": "gulp dist",
     "export": "gulp dist",
     "format": "prettier --ignore-path .gitignore --write \"src/**/*.+(js|ts)\"",
     "lint": "eslint --fix",
-    "local": "gulp local",
+    "local": "gulp dev",
     "testing": "gulp testing",
     "tsbuild": "tsc --build"
   },

src/types/global.d.ts

@@ -1,5 +1,5 @@
-import { RuleValue } from './rule'
 import { AircraftFeature } from '../defs'
+import { RuleValue } from './rule'
 
 declare global {
   namespace Acars {

src/types/types.d.ts

@@ -1,11 +1,13 @@
-import { EngineType } from '../defs'
-import { AircraftFeature } from '../defs'
-import { AircraftType } from '../defs'
-import { FlightPlanType } from '../defs'
-import { GateType } from '../defs'
-import { SimType } from '../defs'
-import { PirepState } from '../defs'
-import { Surface } from '../defs'
+import {
+  AircraftFeature,
+  AircraftType,
+  EngineType,
+  FlightPlanType,
+  GateType,
+  PirepState,
+  SimType,
+  Surface,
+} from '../defs'
 
 /** Point-in-time telemetry from the aircraft */
 export interface Telemetry {