@w5s/configurator-core 1.0.0-alpha.8 → 1.0.0-alpha.9

package/dist/index.d.ts

@@ -1,23 +1,51 @@
-//#region src/FileMode.d.ts
-interface FilePermissionSet {
+//#region src/block.d.ts
+interface BlockOptions {
   /**
-   * Read permission
+   * Block content to insert
    */
-  readonly read?: boolean;
+  block: string;
   /**
-   * Write permission
+   * Insert position
    */
-  readonly write?: boolean;
+  insertPosition?: ['after', 'EndOfFile' | RegExp] | ['before', 'BeginningOfFile' | RegExp];
   /**
-   * Execute permission
+   * The marker builder function that will take either `markerBegin` or `markerEnd`
+   *
+   * @default '# ${mark} MANAGED BLOCK'
    */
-  readonly execute?: boolean;
-}
-interface FileMode {
+  marker?: (mark: 'Begin' | 'End') => string;
   /**
-   * Owner permissions
+   * File path
    */
-  readonly owner?: FilePermissionSet;
+  path: string;
+  /**
+   * Block target state
+   */
+  state?: 'absent' | 'present';
+}
+/**
+ * Replace asynchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function block(options: BlockOptions): Promise<void>;
+/**
+ * Replace synchronously a block in file that follows pattern :
+ *
+ * marker(markerBegin)
+ * ...
+ * marker(markerEnd)
+ *
+ * @param options
+ */
+declare function blockSync(options: BlockOptions): void;
+//#endregion
+//#region src/FileMode.d.ts
+interface FileMode {
   /**
    * Group permissions
    */
@@ -26,10 +54,32 @@ interface FileMode {
    * Other permissions
    */
   readonly other?: FilePermissionSet;
+  /**
+   * Owner permissions
+   */
+  readonly owner?: FilePermissionSet;
+}
+interface FilePermissionSet {
+  /**
+   * Execute permission
+   */
+  readonly execute?: boolean;
+  /**
+   * Read permission
+   */
+  readonly read?: boolean;
+  /**
+   * Write permission
+   */
+  readonly write?: boolean;
 }
 //#endregion
 //#region src/directory.d.ts
 interface DirectoryOptions {
+  /**
+   * File permissions
+   */
+  readonly mode?: FileMode;
   /**
    * Directory path
    */
@@ -37,11 +87,7 @@ interface DirectoryOptions {
   /**
    * Directory target state
    */
-  readonly state: 'present' | 'absent';
-  /**
-   * File permissions
-   */
-  readonly mode?: FileMode;
+  readonly state: 'absent' | 'present';
 }
 /**
  * Ensure directory is present/absent
@@ -82,54 +128,16 @@ declare function directory(options: DirectoryOptions): Promise<void>;
  */
 declare function directorySync(options: DirectoryOptions): void;
 //#endregion
-//#region src/block.d.ts
-interface BlockOptions {
-  /**
-   * The marker builder function that will take either `markerBegin` or `markerEnd`
-   *
-   * @default '# ${mark} MANAGED BLOCK'
-   */
-  marker?: (mark: 'Begin' | 'End') => string;
-  /**
-   * File path
-   */
-  path: string;
-  /**
-   * Block content to insert
-   */
-  block: string;
+//#region src/file.d.ts
+interface FileOptions {
   /**
-   * Insert position
+   * File encoding
    */
-  insertPosition?: ['before', 'BeginningOfFile' | RegExp] | ['after', 'EndOfFile' | RegExp];
+  readonly encoding?: BufferEncoding;
   /**
-   * Block target state
+   * File permissions
    */
-  state?: 'present' | 'absent';
-}
-/**
- * Replace asynchronously a block in file that follows pattern :
- *
- * marker(markerBegin)
- * ...
- * marker(markerEnd)
- *
- * @param options
- */
-declare function block(options: BlockOptions): Promise<void>;
-/**
- * Replace synchronously a block in file that follows pattern :
- *
- * marker(markerBegin)
- * ...
- * marker(markerEnd)
- *
- * @param options
- */
-declare function blockSync(options: BlockOptions): void;
-//#endregion
-//#region src/file.d.ts
-interface FileOptions {
+  readonly mode?: FileMode;
   /**
    * File path
    */
@@ -137,20 +145,12 @@ interface FileOptions {
   /**
    * File target state
    */
-  readonly state: 'present' | 'absent';
+  readonly state: 'absent' | 'present';
   /**
    * File content mapping function
    *
    */
   readonly update?: ((content: string) => string | undefined) | undefined;
-  /**
-   * File encoding
-   */
-  readonly encoding?: BufferEncoding;
-  /**
-   * File permissions
-   */
-  readonly mode?: FileMode;
 }
 /**
  * Ensure file is present/absent with content initialized or modified with `update
@@ -229,15 +229,15 @@ declare function ignoreFile(options: IgnoreFileOptions): Promise<void>;
 declare function ignoreFileSync(options: IgnoreFileOptions): void;
 //#endregion
 //#region src/json.d.ts
-type JSONValue = null | number | string | boolean | JSONValue[] | {
-  [key: string]: JSONValue;
-};
 interface JSONOption<V = JSONValue> extends Omit<FileOptions, 'update'> {
   /**
    * File content mapping function
    */
-  readonly update?: ((content: V | undefined) => V | undefined) | undefined;
+  readonly update?: ((content: undefined | V) => undefined | V) | undefined;
 }
+type JSONValue = boolean | JSONValue[] | null | number | string | {
+  [key: string]: JSONValue;
+};
 /**
  * Ensure file is present/absent asynchronously with content value initialized or modified with `update`
  *
@@ -253,11 +253,34 @@ declare function jsonSync<Value>(options: JSONOption<Value>): void;
 //#endregion
 //#region src/meta.d.ts
 declare const meta: Readonly<{
+  buildNumber: number;
   name: string;
   version: string;
-  buildNumber: number;
 }>;
 //#endregion
+//#region src/yaml.d.ts
+interface YAMLOption<V = YAMLValue> extends Omit<FileOptions, 'update'> {
+  /**
+   * File content mapping function
+   */
+  readonly update?: ((content: undefined | V) => undefined | V) | undefined;
+}
+type YAMLValue = boolean | null | number | string | YAMLValue[] | {
+  [key: string]: YAMLValue;
+};
+/**
+ * Ensure file is present/absent asynchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function yaml<Value>(options: YAMLOption<Value>): Promise<void>;
+/**
+ * Ensure file is present/absent synchronously with content value initialized or modified with `update`
+ *
+ * @param options
+ */
+declare function yamlSync<Value>(options: YAMLOption<Value>): void;
+//#endregion
 //#region src/yarnConfig.d.ts
 interface YarnConfigOptions {
   /**
@@ -267,7 +290,7 @@ interface YarnConfigOptions {
   /**
    * Option target state
    */
-  readonly state: 'present' | 'absent';
+  readonly state: 'absent' | 'present';
   /**
    * File content mapping function
    *
@@ -275,29 +298,29 @@ interface YarnConfigOptions {
   readonly update?: ((content: string) => string | undefined) | undefined;
 }
 /**
- * Synchronous version of {@link yarnConfig}
+ * Set/Unset yarn configuration value
  *
  * @param options
  * @example
- * yarnConfigSync({
+ * await yarnConfig({
  *   key: 'nodeLinker',
  *   state: 'present',
  *   update: (content) => content.replace('node-modules', 'hoisted'),
  * })
  */
-declare function yarnConfigSync(options: YarnConfigOptions): void;
+declare function yarnConfig(options: YarnConfigOptions): Promise<void>;
 /**
- * Set/Unset yarn configuration value
+ * Synchronous version of {@link yarnConfig}
  *
  * @param options
  * @example
- * await yarnConfig({
+ * yarnConfigSync({
  *   key: 'nodeLinker',
  *   state: 'present',
  *   update: (content) => content.replace('node-modules', 'hoisted'),
  * })
  */
-declare function yarnConfig(options: YarnConfigOptions): Promise<void>;
+declare function yarnConfigSync(options: YarnConfigOptions): void;
 //#endregion
 //#region src/yarnVersion.d.ts
 type YarnVersionKind = 'berry' | 'classic';
@@ -305,35 +328,35 @@ interface YarnVersionOptions {
   /**
    * Option target state
    */
-  readonly state: 'present' | 'absent';
+  readonly state: 'absent' | 'present';
   /**
    * Version mapping function
    *
    */
-  readonly update?: (() => YarnVersionKind | undefined) | undefined;
+  readonly update?: (() => undefined | YarnVersionKind) | undefined;
 }
 /**
- * Synchronous version of {@link yarnVersion}
+ * Set/Unset yarn configuration value
  *
  * @param options
  * @example
- * yarnVersionSync({
+ * await yarnVersion({
  *   state: 'present',
  *   update: () => 'berry', // or 'classic'
  * })
  */
-declare function yarnVersionSync(options: YarnVersionOptions): void;
+declare function yarnVersion(options: YarnVersionOptions): Promise<void>;
 /**
- * Set/Unset yarn configuration value
+ * Synchronous version of {@link yarnVersion}
  *
  * @param options
  * @example
- * await yarnVersion({
+ * yarnVersionSync({
  *   state: 'present',
  *   update: () => 'berry', // or 'classic'
  * })
  */
-declare function yarnVersion(options: YarnVersionOptions): Promise<void>;
+declare function yarnVersionSync(options: YarnVersionOptions): void;
 //#endregion
-export { BlockOptions, DirectoryOptions, FileOptions, IgnoreFileOptions, JSONOption, JSONValue, YarnConfigOptions, YarnVersionKind, YarnVersionOptions, block, blockSync, directory, directorySync, file, fileSync, ignoreFile, ignoreFileSync, json, jsonSync, meta, yarnConfig, yarnConfigSync, yarnVersion, yarnVersionSync };
+export { BlockOptions, DirectoryOptions, FileOptions, IgnoreFileOptions, JSONOption, JSONValue, YAMLOption, YAMLValue, YarnConfigOptions, YarnVersionKind, YarnVersionOptions, block, blockSync, directory, directorySync, file, fileSync, ignoreFile, ignoreFileSync, json, jsonSync, meta, yaml, yamlSync, yarnConfig, yarnConfigSync, yarnVersion, yarnVersionSync };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/FileMode.ts","../src/directory.ts","../src/block.ts","../src/file.ts","../src/ignoreFile.ts","../src/json.ts","../src/meta.ts","../src/yarnConfig.ts","../src/yarnVersion.ts"],"mappings":";UAAiB,iBAAA;EAAA;;;EAAA,SAIN,IAAA;EAAA;;;EAAA,SAKA,KAAA;EAKO;AAGlB;;EAHkB,SAAP,OAAA;AAAA;AAAA,UAGM,QAAA;EAcE;;;EAAA,SAVR,KAAA,GAAQ,iBAAA;EAAA;;;EAAA,SAKR,KAAA,GAAQ,iBAAA;EAKA;;AAAiB;EAAjB,SAAR,KAAA,GAAQ,iBAAA;AAAA;;;UCxBF,gBAAA;EDPiB;;;EAAA,SCWvB,IAAA;EDFA;;;EAAA,SCOA,KAAA;EDCM;;;EAAA,SCIN,IAAA,GAAO,QAAQ;AAAA;;;;;;;;;;;ADUU;;;;ACxBpC;;;;iBAmCsB,SAAA,CAAU,OAAA,EAAS,gBAAA,GAAmB,OAAO;;;;;AArBzC;AAqB1B;;;;;;;;AAAmE;AAkCnE;;;;iBAAgB,aAAA,CAAc,OAAyB,EAAhB,gBAAgB;;;UC1EtC,YAAA;EFFA;;;;;EEQf,MAAA,IAAU,IAAA;EFMD;;AAAO;EEDhB,IAAA;EFIuB;;;EECvB,KAAA;EFaiB;;;EERjB,cAAA,kCAAgD,MAAA,4BAAkC,MAAM;EFFvE;;;EEOjB,KAAA;AAAA;;AFGkC;;;;ACxBpC;;;;iBCkIgB,KAAA,CAAM,OAAA,EAAS,YAAA,GAAY,OAAA;;;;;ADpHjB;AAqB1B;;;;iBC4GgB,SAAA,CAAU,OAAqB,EAAZ,YAAY;;;UC/I9B,WAAA;EHPiB;;;EAAA,SGWvB,IAAA;EHFA;;;EAAA,SGOA,KAAA;EHCM;;;;EAAA,SGKN,MAAA,KAAW,OAAA;EHSH;;;EAAA,SGJR,QAAA,GAAW,cAAA;EHNH;;;EAAA,SGWR,IAAA,GAAO,QAAQ;AAAA;;AHDU;;;;ACxBpC;;;;;;;;;AAc0B;AAqB1B;;;;iBEYsB,IAAA,CAAK,OAAA,EAAS,WAAA,GAAc,OAAO;;;;AFZU;AAkCnE;;;;AAAuD;;;;AC1EvD;;;;;;;iBCyFgB,QAAA,CAAS,OAAoB,EAAX,WAAW;;;UCzF5B,iBAAA,SAA0B,IAAI,CAAC,WAAA;EJFd;;;;EAAA,SIOvB,MAAA,KAAW,OAAA;AAAA;;AJOJ;AAGlB;;;;;;;;;;iBIsBsB,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,OAAO;;;;;AJRjC;;;;ACxBpC;;;;iBGgDgB,cAAA,CAAe,OAA0B,EAAjB,iBAAiB;;;KCrD7C,SAAA,sCAA+C,SAAA;EAAA,CAAiB,GAAA,WAAc,SAAS;AAAA;AAAA,UAElF,UAAA,KAAe,SAAA,UAAmB,IAAA,CAAK,WAAA;ELA7C;;;EAAA,SKIA,MAAA,KAAW,OAAA,EAAS,CAAA,iBAAkB,CAAA;AAAA;ALSjD;;;;;AAAA,iBKcsB,IAAA,QAAY,OAAA,EAAS,UAAA,CAAW,KAAA,IAAS,OAAA;;;;;;iBAS/C,QAAA,QAAgB,OAAA,EAAS,UAAU,CAAC,KAAA;;;cCxCvC,IAAA,EAAI,QAAA;;;;;;;UCEA,iBAAA;EPFA;;;EAAA,SOMN,GAAA;EPFA;;;EAAA,SOOA,KAAA;EPGO;AAGlB;;;EAHkB,SOGP,MAAA,KAAW,OAAA;AAAA;;;;;;;;;;;APcc;iBOApB,cAAA,CAAe,OAA0B,EAAjB,iBAAiB;;;ANxBzD;;;;;;;;;iBM6CsB,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,OAAO;;;KClDzD,eAAA;AAAA,UAEK,kBAAA;ERJiB;;;EAAA,SQQvB,KAAA;ERCA;;;AAKO;EALP,SQKA,MAAA,UAAgB,eAAe;AAAA;;;;;;;;;;;iBAa1B,eAAA,CAAgB,OAA2B,EAAlB,kBAAkB;;;ARIvB;;;;ACxBpC;;;;iBOwCsB,WAAA,CAAY,OAAA,EAAS,kBAAA,GAAqB,OAAO"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/block.ts","../src/FileMode.ts","../src/directory.ts","../src/file.ts","../src/ignoreFile.ts","../src/json.ts","../src/meta.ts","../src/yaml.ts","../src/yarnConfig.ts","../src/yarnVersion.ts"],"mappings":";UAEiB,YAAA;EAAA;;;EAIf,KAAA;EAAA;;;EAKA,cAAA,2BAAyC,MAAA,mCAAyC,MAAM;EAOxF;;;;;EAAA,MAAA,IAAU,IAAA;EA0CI;;;EArCd,IAAA;EAqC6B;;;EAhC7B,KAAA;AAAA;AA6CF;;;;AAA+C;;;;ACzE/C;ADyEA,iBAbgB,KAAA,CAAM,OAAA,EAAS,YAAA,GAAY,OAAA;;;;;;;;;;iBAa3B,SAAA,CAAU,OAAqB,EAAZ,YAAY;;;UCzE9B,QAAA;EDEA;;;EAAA,SCEN,KAAA,GAAQ,iBAAA;EDEjB;;;EAAA,SCGS,KAAA,GAAQ,iBAAA;EDSjB;;;EAAA,SCJS,KAAA,GAAQ,iBAAA;AAAA;AAAA,UAGF,iBAAA;ED2CD;;;EAAA,SCvCL,OAAA;EDuCoB;;;EAAA,SClCpB,IAAA;EDkCgC;AAa3C;;EAb2C,SC7BhC,KAAA;AAAA;;;UCtBM,gBAAA;EFPY;;;EAAA,SEWlB,IAAA,GAAO,QAAQ;EFFxB;;;EAAA,SEOS,IAAA;EFAC;;;EAAA,SEKD,KAAA;AAAA;AFqCX;;;;;;;;AAA2C;AAa3C;;;;AAA+C;;;;ACzE/C;AD4DA,iBEhBsB,SAAA,CAAU,OAAA,EAAS,gBAAA,GAAmB,OAAO;;;;;;;;;;;;;;AD9B/B;AAGpC;;;;iBC6DgB,aAAA,CAAc,OAAyB,EAAhB,gBAAgB;;;UCrEtC,WAAA;EHPY;;;EAAA,SGWlB,QAAA,GAAW,cAAA;EHFpB;;;EAAA,SGOS,IAAA,GAAO,QAAQ;EHAd;;;EAAA,SGKD,IAAA;EHKJ;AAgCP;;EAhCO,SGAI,KAAA;EHgCgC;;;;EAAA,SG1BhC,MAAA,KAAW,OAAA;AAAA;AHuCtB;;;;AAA+C;;;;ACzE/C;;;;;;;;;;;ADyEA,iBGjBsB,IAAA,CAAK,OAAA,EAAS,WAAA,GAAc,OAAO;;;;AF1CrB;AAGpC;;;;;;;;AAcgB;;;;ACtBhB;;;iBCoFgB,QAAA,CAAS,OAAoB,EAAX,WAAW;;;UC3F5B,iBAAA,SAA0B,IAAI,CAAC,WAAA;EJAnB;;;;EAAA,SIKlB,MAAA,KAAW,OAAA;AAAA;;;;;;;AJqBf;AAgCP;;;;;iBItCsB,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,OAAO;;;AJsC1B;AAa3C;;;;AAA+C;;;;ACzE/C;iBGsCgB,cAAA,CAAe,OAA0B,EAAjB,iBAAiB;;;UCpCxC,UAAA,KAAe,SAAA,UAAmB,IAAA,CAAK,WAAA;ELA3B;;;EAAA,SKIlB,MAAA,KAAW,OAAA,cAAqB,CAAA,iBAAkB,CAAA;AAAA;AAAA,KAGjD,SAAA,aAAsB,SAAA;EAAA,CAA0C,GAAA,WAAc,SAAS;AAAA;;;;;ALmB5F;iBKZe,IAAA,QAAY,OAAA,EAAS,UAAA,CAAW,KAAA,IAAS,OAAA;;;;;;iBAS/C,QAAA,QAAgB,OAAA,EAAS,UAAU,CAAC,KAAA;;;cCzBvC,IAAA,EAAI,QAAA;;;;;;;UCIA,UAAA,KAAe,SAAA,UAAmB,IAAA,CAAK,WAAA;EPF3B;;;EAAA,SOMlB,MAAA,KAAW,OAAA,cAAqB,CAAA,iBAAkB,CAAA;AAAA;AAAA,KAGjD,SAAA,sCAA+C,SAAA;EAAA,CAAiB,GAAA,WAAc,SAAS;AAAA;;;;;APiB5F;iBOVe,IAAA,QAAY,OAAA,EAAS,UAAA,CAAW,KAAA,IAAS,OAAA;;;;;;iBAS/C,QAAA,QAAgB,OAAA,EAAS,UAAU,CAAC,KAAA;;;UCzBnC,iBAAA;ERAA;;;EAAA,SQIN,GAAA;ERAT;;;EAAA,SQKS,KAAA;EROT;;;;EAAA,SQDS,MAAA,KAAW,OAAA;AAAA;AR2CtB;;;;;;;;AAA2C;AAa3C;;AAbA,iBQ7BsB,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,OAAO;;AR0CtB;;;;ACzE/C;;;;;;iBOoDgB,cAAA,CAAe,OAA0B,EAAjB,iBAAiB;;;KClD7C,eAAA;AAAA,UAEK,kBAAA;ETFY;;;EAAA,SSMlB,KAAA;ETGT;;;;EAAA,SSGS,MAAA,sBAA4B,eAAe;AAAA;;;ATc/C;AAgCP;;;;;;;iBSjCsB,WAAA,CAAY,OAAA,EAAS,kBAAA,GAAqB,OAAO;ATiC5B;AAa3C;;;;AAA+C;;;;ACzE/C;AD4D2C,iBSb3B,eAAA,CAAgB,OAA2B,EAAlB,kBAAkB"}