@isdk/util 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +344 -11
- package/dist/index.d.ts +344 -11
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/ConfigFile.md +9 -9
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/glob.md +1 -1
- package/docs/functions/isStringIn.md +1 -1
- package/docs/functions/normalizeIncludeFiles.md +1 -1
- package/docs/functions/parseFrontMatter.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeLeadingEmptyLines.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/toCamelCase.md +37 -0
- package/docs/functions/toCapitalCase.md +38 -0
- package/docs/functions/toPascalCase.md +37 -0
- package/docs/functions/traverseFolder.md +1 -1
- package/docs/functions/traverseFolderSync.md +1 -1
- package/docs/globals.md +5 -0
- package/docs/interfaces/IncludeFiles.md +3 -3
- package/docs/interfaces/LoadConfigFileOptions.md +25 -0
- package/docs/type-aliases/StringifyFunc.md +21 -0
- package/docs/type-aliases/TraverseFolderHandler.md +1 -1
- package/docs/type-aliases/TraverseFolderSyncHandler.md +1 -1
- package/docs/variables/DefaultAllTextFiles.md +1 -1
- package/package.json +1 -1
- package/dist/chunk-3TCMKKX2.mjs +0 -1
- package/dist/chunk-46TT3NZV.mjs +0 -1
- package/dist/chunk-7APJBRA7.mjs +0 -1
- package/dist/chunk-7AQU3PBW.mjs +0 -1
- package/dist/chunk-D3BCI5SM.mjs +0 -1
- package/dist/chunk-FXF2KJLF.mjs +0 -1
- package/dist/chunk-GGOKSJK4.mjs +0 -1
- package/dist/chunk-JTTOXXPG.mjs +0 -1
- package/dist/chunk-LOMQZH4U.mjs +0 -292
- package/dist/chunk-OTEAFARC.mjs +0 -1
- package/dist/chunk-UJZVJIGI.mjs +0 -1
- package/dist/config-file.d.mts +0 -75
- package/dist/config-file.d.ts +0 -75
- package/dist/config-file.js +0 -1
- package/dist/config-file.mjs +0 -1
- package/dist/config-file.test.d.mts +0 -2
- package/dist/config-file.test.d.ts +0 -2
- package/dist/config-file.test.js +0 -292
- package/dist/config-file.test.mjs +0 -1
- package/dist/front-matter.d.mts +0 -6
- package/dist/front-matter.d.ts +0 -6
- package/dist/front-matter.js +0 -1
- package/dist/front-matter.mjs +0 -1
- package/dist/front-matter.test.d.mts +0 -2
- package/dist/front-matter.test.d.ts +0 -2
- package/dist/front-matter.test.js +0 -1
- package/dist/front-matter.test.mjs +0 -1
- package/dist/get-multi-level-extname.d.mts +0 -9
- package/dist/get-multi-level-extname.d.ts +0 -9
- package/dist/get-multi-level-extname.js +0 -1
- package/dist/get-multi-level-extname.mjs +0 -1
- package/dist/glob.d.mts +0 -28
- package/dist/glob.d.ts +0 -28
- package/dist/glob.js +0 -1
- package/dist/glob.mjs +0 -1
- package/dist/glob.test.d.mts +0 -2
- package/dist/glob.test.d.ts +0 -2
- package/dist/glob.test.js +0 -292
- package/dist/glob.test.mjs +0 -1
- package/dist/include-files.d.mts +0 -31
- package/dist/include-files.d.ts +0 -31
- package/dist/include-files.js +0 -1
- package/dist/include-files.mjs +0 -1
- package/dist/include-files.test.d.mts +0 -2
- package/dist/include-files.test.d.ts +0 -2
- package/dist/include-files.test.js +0 -292
- package/dist/include-files.test.mjs +0 -1
- package/dist/is-string-in.d.mts +0 -19
- package/dist/is-string-in.d.ts +0 -19
- package/dist/is-string-in.js +0 -1
- package/dist/is-string-in.mjs +0 -1
- package/dist/magic-string.es-TUA2PMWY.mjs +0 -1
- package/dist/remove-leading-empty-lines.d.mts +0 -18
- package/dist/remove-leading-empty-lines.d.ts +0 -18
- package/dist/remove-leading-empty-lines.js +0 -1
- package/dist/remove-leading-empty-lines.mjs +0 -1
- package/dist/remove-leading-empty-lines.test.d.mts +0 -2
- package/dist/remove-leading-empty-lines.test.d.ts +0 -2
- package/dist/remove-leading-empty-lines.test.js +0 -1
- package/dist/remove-leading-empty-lines.test.mjs +0 -1
- package/dist/traverse-folder.d.mts +0 -56
- package/dist/traverse-folder.d.ts +0 -56
- package/dist/traverse-folder.js +0 -1
- package/dist/traverse-folder.mjs +0 -1
- package/dist/traverse-folder.test.d.mts +0 -2
- package/dist/traverse-folder.test.d.ts +0 -2
- package/dist/traverse-folder.test.js +0 -292
- package/dist/traverse-folder.test.mjs +0 -1
- package/dist/yaml.d.mts +0 -59
- package/dist/yaml.d.ts +0 -59
- package/dist/yaml.js +0 -1
- package/dist/yaml.mjs +0 -1
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@isdk/util**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/util](../globals.md) / toPascalCase
|
|
6
|
+
|
|
7
|
+
# Function: toPascalCase()
|
|
8
|
+
|
|
9
|
+
> **toPascalCase**(`str`): `string`
|
|
10
|
+
|
|
11
|
+
Defined in: [to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/to-pascal-case.ts#L16)
|
|
12
|
+
|
|
13
|
+
Converts a string to PascalCase.
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### str
|
|
18
|
+
|
|
19
|
+
`string`
|
|
20
|
+
|
|
21
|
+
The string to convert.
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`string`
|
|
26
|
+
|
|
27
|
+
The PascalCase version of the string.
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
console.log(toPascalCase("some-word")); // Output: "SomeWord"
|
|
33
|
+
console.log(toPascalCase("some_Word")); // Output: "SomeWord"
|
|
34
|
+
console.log(toPascalCase("someWord")); // Output: "SomeWord"
|
|
35
|
+
console.log(toPascalCase("some word")); // Output: "SomeWord"
|
|
36
|
+
console.log(toPascalCase("SOME_WORD")); // Output: "SomeWord"
|
|
37
|
+
```
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **traverseFolder**(`directoryPath`, `fileHandler`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [traverse-folder.ts:38](https://github.com/isdk/util.js/blob/
|
|
11
|
+
Defined in: [traverse-folder.ts:38](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/traverse-folder.ts#L38)
|
|
12
12
|
|
|
13
13
|
Traverses a folder asynchronously and applies a handler to each file or directory.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **traverseFolderSync**(`directoryPath`, `fileHandler`): `void`
|
|
10
10
|
|
|
11
|
-
Defined in: [traverse-folder.ts:66](https://github.com/isdk/util.js/blob/
|
|
11
|
+
Defined in: [traverse-folder.ts:66](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/traverse-folder.ts#L66)
|
|
12
12
|
|
|
13
13
|
Traverses a folder synchronously and applies a handler to each file or directory.
|
|
14
14
|
|
package/docs/globals.md
CHANGED
|
@@ -11,9 +11,11 @@
|
|
|
11
11
|
## Interfaces
|
|
12
12
|
|
|
13
13
|
- [IncludeFiles](interfaces/IncludeFiles.md)
|
|
14
|
+
- [LoadConfigFileOptions](interfaces/LoadConfigFileOptions.md)
|
|
14
15
|
|
|
15
16
|
## Type Aliases
|
|
16
17
|
|
|
18
|
+
- [StringifyFunc](type-aliases/StringifyFunc.md)
|
|
17
19
|
- [TraverseFolderHandler](type-aliases/TraverseFolderHandler.md)
|
|
18
20
|
- [TraverseFolderSyncHandler](type-aliases/TraverseFolderSyncHandler.md)
|
|
19
21
|
|
|
@@ -32,5 +34,8 @@
|
|
|
32
34
|
- [registerYamlTag](functions/registerYamlTag.md)
|
|
33
35
|
- [removeLeadingEmptyLines](functions/removeLeadingEmptyLines.md)
|
|
34
36
|
- [stringifyYaml](functions/stringifyYaml.md)
|
|
37
|
+
- [toCamelCase](functions/toCamelCase.md)
|
|
38
|
+
- [toCapitalCase](functions/toCapitalCase.md)
|
|
39
|
+
- [toPascalCase](functions/toPascalCase.md)
|
|
35
40
|
- [traverseFolder](functions/traverseFolder.md)
|
|
36
41
|
- [traverseFolderSync](functions/traverseFolderSync.md)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: IncludeFiles
|
|
8
8
|
|
|
9
|
-
Defined in: [include-files.ts:6](https://github.com/isdk/util.js/blob/
|
|
9
|
+
Defined in: [include-files.ts:6](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/include-files.ts#L6)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [include-files.ts:6](https://github.com/isdk/util.js/blob/9d50730dc1
|
|
|
14
14
|
|
|
15
15
|
> `optional` **exclude**: `string`[]
|
|
16
16
|
|
|
17
|
-
Defined in: [include-files.ts:8](https://github.com/isdk/util.js/blob/
|
|
17
|
+
Defined in: [include-files.ts:8](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/include-files.ts#L8)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [include-files.ts:8](https://github.com/isdk/util.js/blob/9d50730dc1
|
|
|
22
22
|
|
|
23
23
|
> `optional` **include**: `string`[]
|
|
24
24
|
|
|
25
|
-
Defined in: [include-files.ts:7](https://github.com/isdk/util.js/blob/
|
|
25
|
+
Defined in: [include-files.ts:7](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/include-files.ts#L7)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@isdk/util**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/util](../globals.md) / LoadConfigFileOptions
|
|
6
|
+
|
|
7
|
+
# Interface: LoadConfigFileOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [config-file.ts:20](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/config-file.ts#L20)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### externalFile?
|
|
14
|
+
|
|
15
|
+
> `optional` **externalFile**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [config-file.ts:22](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/config-file.ts#L22)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### extLevel?
|
|
22
|
+
|
|
23
|
+
> `optional` **extLevel**: `number`
|
|
24
|
+
|
|
25
|
+
Defined in: [config-file.ts:21](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/config-file.ts#L21)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[**@isdk/util**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/util](../globals.md) / StringifyFunc
|
|
6
|
+
|
|
7
|
+
# Type Alias: StringifyFunc()
|
|
8
|
+
|
|
9
|
+
> **StringifyFunc** = (`content`) => `string`
|
|
10
|
+
|
|
11
|
+
Defined in: [config-file.ts:18](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/config-file.ts#L18)
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
### content
|
|
16
|
+
|
|
17
|
+
`any`
|
|
18
|
+
|
|
19
|
+
## Returns
|
|
20
|
+
|
|
21
|
+
`string`
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TraverseFolderHandler** = (`filePath`, `entry`) => `boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [traverse-folder.ts:11](https://github.com/isdk/util.js/blob/
|
|
11
|
+
Defined in: [traverse-folder.ts:11](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/traverse-folder.ts#L11)
|
|
12
12
|
|
|
13
13
|
A handler function for asynchronous folder traversal.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TraverseFolderSyncHandler** = (`filePath`, `entry`) => `boolean` \| `void`
|
|
10
10
|
|
|
11
|
-
Defined in: [traverse-folder.ts:18](https://github.com/isdk/util.js/blob/
|
|
11
|
+
Defined in: [traverse-folder.ts:18](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/traverse-folder.ts#L18)
|
|
12
12
|
|
|
13
13
|
A handler function for synchronous folder traversal.
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DefaultAllTextFiles**: `string`[]
|
|
10
10
|
|
|
11
|
-
Defined in: [include-files.ts:1](https://github.com/isdk/util.js/blob/
|
|
11
|
+
Defined in: [include-files.ts:1](https://github.com/isdk/util.js/blob/d56ec17a58f2c8d32fa62a973286199a24a5c2c7/src/include-files.ts#L1)
|
package/package.json
CHANGED
package/dist/chunk-3TCMKKX2.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{parseFrontMatter as t}from"./chunk-JTTOXXPG.mjs";import{parseYaml as r,stringifyYaml as o}from"./chunk-OTEAFARC.mjs";import{getMultiLevelExtname as n}from"./chunk-7AQU3PBW.mjs";import{init_esm_shims as e}from"./chunk-UJZVJIGI.mjs";e();import{existsSync as i,mkdirSync as m,readFileSync as s,writeFileSync as f}from"fs";import c from"path";import{Config as u}from"load-config-file";var l=class{static register(t,r,o){u.register(t,r),"string"==typeof t&&(t=[t]);for(const r of t)this.stringifys[r]=o}static load(r,o){return function(r,{extLevel:o=1,externalFile:e}={}){"."===r[0]&&o++;const m=n(r,o);m&&m.split(".").length>1&&(r=r.slice(0,-m.length));let f=u.loadSync(r);if(!f&&e){if(!c.isAbsolute(e)){const t=c.dirname(r);e=c.join(t,e)}if(i(e)){const r=t(s(e,"utf8")).data;Object.keys(r).length&&(f=r)}}return f}(r,o)}static save(t,r,o){return function(t,r,{extLevel:o=1}={}){"."===t[0]&&o++;let e=n(t,o);(!e||e.split(".").length<=1)&&(t+=".yaml",e=".yaml");const s=l.stringifys[e];if(!s)throw new Error(`${t} unsupported mime type: ${e}`);r=s(r);const u=c.dirname(t);i(u)||m(u,{recursive:!0});return f(t,r,{encoding:"utf8"}),t}(t,r,o)}};l.stringifys={},l.register([".yml",".yaml"],r,o),l.register([".json"],(function(t){return JSON.parse(t)}),(t=>JSON.stringify(t,null,2)));export{l as ConfigFile};
|
package/dist/chunk-46TT3NZV.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as o}from"./chunk-UJZVJIGI.mjs";o();import{readdir as r}from"fs/promises";import{readdirSync as i}from"fs";import t from"path";async function s(o,i){const s=await r(o,{withFileTypes:!0,recursive:!0});for(const r of s){const s=t.join(o,r.name);if(!0===await i(s,r))break}}function f(o,r){const s=i(o,{withFileTypes:!0,recursive:!0});for(const i of s){if(!0===r(t.join(o,i.name),i))break}}export{s as traverseFolder,f as traverseFolderSync};
|
package/dist/chunk-7APJBRA7.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as o}from"./chunk-UJZVJIGI.mjs";o();import{globMatch as r}from"@isdk/glob";import m from"path";function t(o,t,i){return i&&(o=m.relative(i,o)),r(o,t)}export{t as glob};
|
package/dist/chunk-7AQU3PBW.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as r}from"./chunk-UJZVJIGI.mjs";r();import o from"path";function t(r,t=1){let f="";for(;t--;){const t=o.extname(r);if(!t)break;f=t+f,r=o.basename(r,t)}return f}export{t as getMultiLevelExtname};
|
package/dist/chunk-D3BCI5SM.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as n}from"./chunk-UJZVJIGI.mjs";function r(n){const r=/^\s*(#[^\r\n]*)?[\r\n]+/;let o;for(;null!==(o=r.exec(n))&&((n=n.substring(o[0].length)).startsWith("\n")||n.startsWith("\r")||n.trimStart().startsWith("#")););return n}n();export{r as removeLeadingEmptyLines};
|
package/dist/chunk-FXF2KJLF.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as r}from"./chunk-UJZVJIGI.mjs";function t(r,t){return"string"==typeof t&&(t=[t]),-1!==t.indexOf(r)}r();export{t as isStringIn};
|
package/dist/chunk-GGOKSJK4.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{init_esm_shims as s}from"./chunk-UJZVJIGI.mjs";s();var t=["**/*.((j|t)s?(x)|m(j|t)s)?(x)","**/*.(md|markdown|txt|?(x)htm?(l)|yaml|yml|xml|json|bat|sh|bash|zsh|ini|css|scss|less|sass|py|rb|php|go|java|c|cpp|h|hpp|hxx|rust|zig)"];function r(s,r=t){if(s)if(Array.isArray(s))s=[...s];else{const t=s.include||[],o=s.exclude||[];0===t.length&&t.push(...r),s=[...t];for(const t of o)s.push(`!${t}`)}else s=[...r];return 0===s.length&&s.push(...r),s}export{t as DefaultAllTextFiles,r as normalizeIncludeFiles};
|
package/dist/chunk-JTTOXXPG.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{removeLeadingEmptyLines as n}from"./chunk-D3BCI5SM.mjs";import{parseYaml as t}from"./chunk-OTEAFARC.mjs";import{init_esm_shims as o}from"./chunk-UJZVJIGI.mjs";o();function r(o,r="---"){const c=r.length,m=n(o);if(m.startsWith(r)&&("\n"===m[r.length]||"\r"===m[r.length])){let n=m.indexOf("\n"+r,c);if(-1!==n){const o=m.slice(c,n);for(n+=r.length+1;"\n"===m[n]||"\r"===m[n];)n++;const f=m.slice(n);return{data:t(o)||{},content:f}}}return{data:{},content:o}}export{r as parseFrontMatter};
|