@flightdev/helpers 0.1.0 → 0.1.1
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/README.md +7 -7
- package/package.json +7 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @flightdev/helpers
|
|
2
2
|
|
|
3
3
|
Optional helper utilities for Flight Framework. **Suggestions, not impositions.**
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@ This package provides utilities that **suggest** configurations based on your pr
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npm install @
|
|
12
|
+
npm install @flightdev/helpers
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
@@ -17,7 +17,7 @@ npm install @flight-framework/helpers
|
|
|
17
17
|
### Detect UI Framework
|
|
18
18
|
|
|
19
19
|
```typescript
|
|
20
|
-
import { detectFramework } from '@
|
|
20
|
+
import { detectFramework } from '@flightdev/helpers/detect';
|
|
21
21
|
|
|
22
22
|
const result = await detectFramework();
|
|
23
23
|
|
|
@@ -40,7 +40,7 @@ if (result.framework) {
|
|
|
40
40
|
### Detect Deployment Target
|
|
41
41
|
|
|
42
42
|
```typescript
|
|
43
|
-
import { detectDeploymentTarget } from '@
|
|
43
|
+
import { detectDeploymentTarget } from '@flightdev/helpers/detect';
|
|
44
44
|
|
|
45
45
|
const result = await detectDeploymentTarget();
|
|
46
46
|
|
|
@@ -54,13 +54,13 @@ console.log(result);
|
|
|
54
54
|
|
|
55
55
|
// You decide whether to use this
|
|
56
56
|
console.log(`Suggested adapter: ${result.adapter}`);
|
|
57
|
-
console.log(`To install: npm install @
|
|
57
|
+
console.log(`To install: npm install @flightdev/adapter-${result.adapter}`);
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
### Suggest Defaults
|
|
61
61
|
|
|
62
62
|
```typescript
|
|
63
|
-
import { suggestDefaults } from '@
|
|
63
|
+
import { suggestDefaults } from '@flightdev/helpers/suggest';
|
|
64
64
|
|
|
65
65
|
const suggestions = await suggestDefaults();
|
|
66
66
|
|
|
@@ -78,7 +78,7 @@ console.log(suggestions);
|
|
|
78
78
|
|
|
79
79
|
// Use in your config if you want
|
|
80
80
|
// flight.config.ts
|
|
81
|
-
import { defineConfig } from '@
|
|
81
|
+
import { defineConfig } from '@flightdev/core';
|
|
82
82
|
|
|
83
83
|
export default defineConfig({
|
|
84
84
|
ui: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flightdev/helpers",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Optional helper utilities for Flight Framework. Suggestions, not impositions.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -39,6 +39,12 @@
|
|
|
39
39
|
"typescript": "^5.3.0",
|
|
40
40
|
"vitest": "^1.0.0"
|
|
41
41
|
},
|
|
42
|
+
"homepage": "https://github.com/EliosLT/FlightDev",
|
|
43
|
+
"repository": {
|
|
44
|
+
"url": "https://github.com/EliosLT/FlightDev.git",
|
|
45
|
+
"directory": "packages/helpers",
|
|
46
|
+
"type": "git"
|
|
47
|
+
},
|
|
42
48
|
"scripts": {
|
|
43
49
|
"build": "tsup",
|
|
44
50
|
"dev": "tsup --watch",
|