chore: rename main func

Author: piquark6046

sources/preprocessing/index.ts sources/filter-args/index.tssources/preprocessing/index.ts renamed to sources/filter-args/index.ts

@@ -9,7 +9,7 @@ type DropFirst<T extends readonly unknown[]> = T extends readonly [unknown, ...i
  * @param {string} Args - A value of `process.argv`.
  * @returns A filtered `process.argv` with only options and their values.
  */
-export function PreProcessing<Args extends typeof Process.argv>(Args: Args): DropFirstANDTwo<Args> | DropFirst<Args> {
+export function FilterArgumentsForOptions<Args extends typeof Process.argv>(Args: Args): DropFirstANDTwo<Args> | DropFirst<Args> {
   if (Args[2].startsWith('--')) {
     return Args.slice(2) as DropFirstANDTwo<Args>
   } else {

sources/index.ts

@@ -1,5 +1,5 @@
-export { PostProcessing } from './postprocessing/index.js'
+export { ParseArgumentsAndOptions } from './parse-args/index.js'
 
-export { PreProcessing } from './preprocessing/index.js'
+export { FilterArgumentsForOptions } from './filter-args/index.js'
 
 export type { JSONValue, JSONArray, JSONObject, JSONPrimitive, IParsingOptions } from './types.js'

sources/postprocessing/index.ts sources/parse-args/index.tssources/postprocessing/index.ts renamed to sources/parse-args/index.ts

@@ -9,7 +9,7 @@ import type { JSONValue, IParsingOptions } from '../types.js'
  * @param FuncOptions - Configuration for post-processing behavior, such as the naming convention transformer.
  * @returns A promise resolving to an object containing the parsed options and remaining positional arguments.
  */
-export async function PostProcessing<I extends JSONValue>(Args: string[], FuncOptions: IParsingOptions = {
+export async function ParseArgumentsAndOptions<I extends JSONValue>(Args: string[], FuncOptions: IParsingOptions = {
   NamingConvention: ESToolkit.pascalCase
 }): Promise<{ Options: I, Positional: string[] }> {
   const Options: Record<string, boolean | string> = Object.create(null)

…s/preprocessing/remove-exec-file.test.ts …sts/filter-args/remove-exec-file.test.tstests/preprocessing/remove-exec-file.test.ts renamed to tests/filter-args/remove-exec-file.test.ts tests/preprocessing/remove-exec-file.test.ts renamed to tests/filter-args/remove-exec-file.test.ts

@@ -1,26 +1,26 @@
 import test from 'ava'
-import { PreProcessing } from '@/index.js'
+import { FilterArgumentsForOptions } from '@/index.js'
 
-test('PreProcessing strips Node executable from argv (nvm and 24.11.1)', T => {
+test('FilterArgumentsForOptions strips Node executable from argv (nvm and 24.11.1)', T => {
   let Input = ['/usr/local/share/nvm/versions/node/v24.11.1/bin/node', '/path/to/node.js', '--sample', 'sample1']
   let Expected = ['--sample', 'sample1']
 
-  let Processed = PreProcessing(Input)
+  let Processed = FilterArgumentsForOptions(Input)
   T.deepEqual(Processed, Expected)
 })
 
-test('PreProcessing strips Node executable from argv (alpine package manager)', T => {
+test('FilterArgumentsForOptions strips Node executable from argv (alpine package manager)', T => {
   let Input = ['/usr/bin/node', '/path/to/node.js', '--sample', 'sample1']
   let Expected = ['--sample', 'sample1']
 
-  let Processed = PreProcessing(Input)
+  let Processed = FilterArgumentsForOptions(Input)
   T.deepEqual(Processed, Expected)
 })
 
-test('PreProcessing strips Node executable from argv (node:24-alpine container)', T => {
+test('FilterArgumentsForOptions strips Node executable from argv (node:24-alpine container)', T => {
   let Input = ['/usr/local/bin/node', '/path/to/node.js', '--sample', 'sample1']
   let Expected = ['--sample', 'sample1']
 
-  let Processed = PreProcessing(Input)
+  let Processed = FilterArgumentsForOptions(Input)
   T.deepEqual(Processed, Expected)
 })

tests/filter-args/remove-exec-nofile.test.ts

@@ -0,0 +1,26 @@
+import test from 'ava'
+import { FilterArgumentsForOptions } from '@/index.js'
+
+test('FilterArgumentsForOptions strips Node executable from argv (nvm and 24.11.1)', T => {
+  let Input = ['/usr/local/share/nvm/versions/node/v24.11.1/bin/node', '--sample', 'sample1']
+  let Expected = ['--sample', 'sample1']
+  
+  let Processed = FilterArgumentsForOptions(Input)
+  T.deepEqual(Processed, Expected)
+})
+
+test('FilterArgumentsForOptions strips Node executable from argv (alpine package manager)', T => {
+  let Input = ['/usr/bin/node', '--sample', 'sample1']
+  let Expected = ['--sample', 'sample1']
+  
+  let Processed = FilterArgumentsForOptions(Input)
+  T.deepEqual(Processed, Expected)
+})
+
+test('FilterArgumentsForOptions strips Node executable from argv (node:24-alpine container)', T => {
+  let Input = ['/usr/local/bin/node', '--sample', 'sample1']
+  let Expected = ['--sample', 'sample1']
+  
+  let Processed = FilterArgumentsForOptions(Input)
+  T.deepEqual(Processed, Expected)
+})

…postprocessing/boolean-parameter.test.ts …sts/parse-args/boolean-parameter.test.tstests/postprocessing/boolean-parameter.test.ts renamed to tests/parse-args/boolean-parameter.test.ts tests/postprocessing/boolean-parameter.test.ts renamed to tests/parse-args/boolean-parameter.test.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { PostProcessing } from '@/index.js'
+import { ParseArgumentsAndOptions } from '@/index.js'
 
 test('boolean flag located at beginning without value should be true', async T => {
   let Input = ['--enable-feature', '--parameter', 'value']
@@ -8,7 +8,7 @@ test('boolean flag located at beginning without value should be true', async T =
     Parameter: 'value'
   }
 
-  T.deepEqual(await PostProcessing(Input), { Options: Expected, Positional: []})
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
 })
 
 test('boolean flag located at end without value should be true', async T => {
@@ -18,7 +18,7 @@ test('boolean flag located at end without value should be true', async T => {
     EnableFeature: true
   }
 
-  T.deepEqual(await PostProcessing(Input), { Options: Expected, Positional: []})
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
 })
 
 test('boolean flag located in middle without value should be true', async T => {
@@ -29,5 +29,5 @@ test('boolean flag located in middle without value should be true', async T => {
     Parameter2: 'value2'
   }
 
-  T.deepEqual(await PostProcessing(Input), { Options: Expected, Positional: []})
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
 })

tests/parse-args/remaining-normal-value.test.ts

@@ -0,0 +1,22 @@
+import test from 'ava'
+import { ParseArgumentsAndOptions } from '@/index.js'
+
+test('ParseArgumentsAndOptions a single parameter',async T => {
+  let Input = ['--Parameter1', 'Value1', '--Parameter2', 'Value2', '--', '--deserunt', 'tempor', '--dolor', 'tempor']
+  let Expected = {
+    Parameter1: 'Value1',
+    Parameter2: 'Value2'
+  }
+  
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: ['--deserunt', 'tempor', '--dolor', 'tempor']})
+})
+
+test('ParseArgumentsAndOptions a single parameter with no upper case', async T => {
+  let Input = ['--parameter1', 'value1', '--parameter2', 'value2', '--', '--deserunt', 'tempor', '--dolor', 'tempor']
+  let Expected = {
+    Parameter1: 'value1',
+    Parameter2: 'value2'
+  }
+  
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: ['--deserunt', 'tempor', '--dolor', 'tempor']})
+})

tests/parse-args/single-parameter.test.ts

@@ -0,0 +1,20 @@
+import test from 'ava'
+import { ParseArgumentsAndOptions } from '@/index.js'
+
+test('ParseArgumentsAndOptions a single parameter', async T => {
+  let Input = ['--Parameter1', 'Value1']
+  let Expected = {
+    Parameter1: 'Value1'
+  }
+
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
+})
+
+test('ParseArgumentsAndOptions a single parameter with no upper case', async T => {
+  let Input = ['--parameter1', 'value1']
+  let Expected = {
+    Parameter1: 'value1'
+  }
+
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
+})

tests/parse-args/two-parameter.test.ts

@@ -0,0 +1,22 @@
+import test from 'ava'
+import { ParseArgumentsAndOptions } from '@/index.js'
+
+test('ParseArgumentsAndOptions a single parameter',async T => {
+  let Input = ['--Parameter1', 'Value1', '--Parameter2', 'Value2']
+  let Expected = {
+    Parameter1: 'Value1',
+    Parameter2: 'Value2'
+  }
+  
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
+})
+
+test('ParseArgumentsAndOptions a single parameter with no upper case', async T => {
+  let Input = ['--parameter1', 'value1', '--parameter2', 'value2']
+  let Expected = {
+    Parameter1: 'value1',
+    Parameter2: 'value2'
+  }
+  
+  T.deepEqual(await ParseArgumentsAndOptions(Input), { Options: Expected, Positional: []})
+})