You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+6-67Lines changed: 6 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,75 +2,14 @@
2
2
3
3
# Using Vite+, the Unified Toolchain for the Web
4
4
5
-
This project is using Vite+, a unified toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task. Vite+ wraps runtime management, package management, and frontend tooling in a single global CLI called `vp`. Vite+ is distinct from Vite, but it invokes Vite through `vp dev` and `vp build`.
5
+
This project is using Vite+, a unified toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task. Vite+ wraps runtime management, package management, and frontend tooling in a single global CLI called `vp`. Vite+ is distinct from Vite, and it invokes Vite through `vp dev` and `vp build`. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command.
6
6
7
-
## Vite+ Workflow
7
+
Docs are local at `node_modules/vite-plus/docs` or online at https://viteplus.dev/guide/.
8
8
9
-
`vp` is a global binary that handles the full development lifecycle. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command.
10
-
11
-
### Start
12
-
13
-
- create - Create a new project from a template
14
-
- migrate - Migrate an existing project to Vite+
15
-
- config - Configure hooks and agent integration
16
-
- staged - Run linters on staged files
17
-
- install (`i`) - Install dependencies
18
-
- env - Manage Node.js versions
19
-
20
-
### Develop
21
-
22
-
- dev - Run the development server
23
-
- check - Run format, lint, and TypeScript type checks
24
-
- lint - Lint code
25
-
- fmt - Format code
26
-
- test - Run tests
27
-
28
-
### Execute
29
-
30
-
- run - Run monorepo tasks
31
-
- exec - Execute a command from local `node_modules/.bin`
32
-
- dlx - Execute a package binary without installing it as a dependency
33
-
- cache - Manage the task cache
34
-
35
-
### Build
36
-
37
-
- build - Build for production
38
-
- pack - Build libraries
39
-
- preview - Preview production build
40
-
41
-
### Manage Dependencies
42
-
43
-
Vite+ automatically detects and wraps the underlying package manager such as pnpm, npm, or Yarn through the `packageManager` field in `package.json` or package manager-specific lockfiles.
44
-
45
-
- add - Add packages to dependencies
46
-
- remove (`rm`, `un`, `uninstall`) - Remove packages from dependencies
47
-
- update (`up`) - Update packages to latest versions
48
-
- dedupe - Deduplicate dependencies
49
-
- outdated - Check for outdated packages
50
-
- list (`ls`) - List installed packages
51
-
- why (`explain`) - Show why a package is installed
52
-
- info (`view`, `show`) - View package information from the registry
53
-
- link (`ln`) / unlink - Manage local package links
54
-
- pm - Forward a command to the package manager
55
-
56
-
### Maintain
57
-
58
-
- upgrade - Update `vp` itself to the latest version
59
-
60
-
These commands map to their corresponding tools. For example, `vp dev --port 3000` runs Vite's dev server and works the same as Vite. `vp test` runs JavaScript tests through the bundled Vitest. The version of all tools can be checked using `vp --version`. This is useful when researching documentation, features, and bugs.
61
-
62
-
## Common Pitfalls
63
-
64
-
-**Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations.
65
-
-**Always use Vite commands to run tools:** Don't attempt to run `vp vitest` or `vp oxlint`. They do not exist. Use `vp test` and `vp lint` instead.
66
-
-**Running scripts:** Vite+ commands take precedence over `package.json` scripts. If there is a `test` script defined in `scripts` that conflicts with the built-in `vp test` command, run it using `vp run test`.
67
-
-**Do not install Vitest, Oxlint, Oxfmt, or tsdown directly:** Vite+ wraps these tools. They must not be installed directly. You cannot upgrade these tools by installing their latest versions. Always use Vite+ commands.
68
-
-**Use Vite+ wrappers for one-off binaries:** Use `vp dlx` instead of package-manager-specific `dlx`/`npx` commands.
69
-
-**Import JavaScript modules from `vite-plus`:** Instead of importing from `vite` or `vitest`, all modules should be imported from the project's `vite-plus` dependency. For example, `import { defineConfig } from 'vite-plus';` or `import { expect, test, vi } from 'vite-plus/test';`. You must not install `vitest` to import test utilities.
70
-
-**Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box.
71
-
72
-
## Review Checklist for Agents
9
+
## Review Checklist
73
10
74
11
-[ ] Run `vp install` after pulling remote changes and before getting started.
75
-
-[ ] Run `vp check` and `vp test` to validate changes.
12
+
-[ ] Run `vp check` and `vp test` to format, lint, type check and test changes.
13
+
-[ ] Check if there are `vite.config.ts` tasks or `package.json` scripts necessary for validation, run via `vp run <script>`.
Copy file name to clipboardExpand all lines: README.md
+16-50Lines changed: 16 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,13 @@ See the `examples/demo` directory for a full working example.
24
24
25
25
<docgen-index>
26
26
27
-
*[`initialize(...)`](#initialize)
28
-
*[`login(...)`](#login)
29
-
*[`logout()`](#logout)
30
-
*[`setConsentRequired(...)`](#setconsentrequired)
31
-
*[`setConsentGiven(...)`](#setconsentgiven)
32
-
*[Interfaces](#interfaces)
33
-
*[Type Aliases](#type-aliases)
27
+
-[`initialize(...)`](#initialize)
28
+
-[`login(...)`](#login)
29
+
-[`logout()`](#logout)
30
+
-[`setConsentRequired(...)`](#setconsentrequired)
31
+
-[`setConsentGiven(...)`](#setconsentgiven)
32
+
-[Interfaces](#interfaces)
33
+
-[Type Aliases](#type-aliases)
34
34
35
35
</docgen-index>
36
36
@@ -51,8 +51,7 @@ Initialize the SDK with your OneSignal app ID. Call during app startup.
51
51
| ----------- | ------------------- |
52
52
|**`appId`**| <code>string</code> |
53
53
54
-
--------------------
55
-
54
+
---
56
55
57
56
### login(...)
58
57
@@ -66,8 +65,7 @@ Log in to OneSignal as the user identified by `externalId`, switching the user c
66
65
| ---------------- | ------------------- |
67
66
|**`externalId`**| <code>string</code> |
68
67
69
-
--------------------
70
-
68
+
---
71
69
72
70
### logout()
73
71
@@ -77,8 +75,7 @@ logout() => Promise<void>
77
75
78
76
Log out the current user. The SDK will reference a new device-scoped user.
79
77
80
-
--------------------
81
-
78
+
---
82
79
83
80
### setConsentRequired(...)
84
81
@@ -92,8 +89,7 @@ Set whether user privacy consent is required before sending data to OneSignal. C
92
89
| -------------- | -------------------- |
93
90
|**`required`**| <code>boolean</code> |
94
91
95
-
--------------------
96
-
92
+
---
97
93
98
94
### setConsentGiven(...)
99
95
@@ -107,12 +103,10 @@ Indicate whether the user has granted privacy consent.
107
103
| ------------- | -------------------- |
108
104
|**`granted`**| <code>boolean</code> |
109
105
110
-
--------------------
111
-
106
+
---
112
107
113
108
### Interfaces
114
109
115
-
116
110
#### OneSignalDebugAPI
117
111
118
112
Debug helpers exposed via `OneSignal.Debug`.
@@ -122,7 +116,6 @@ Debug helpers exposed via `OneSignal.Debug`.
122
116
|**setLogLevel**| (logLevel: <ahref="#loglevel">LogLevel</a>) => void | Set the log level printed to LogCat (Android) or the Xcode console (iOS). |
123
117
|**setAlertLevel**| (visualLogLevel: <ahref="#loglevel">LogLevel</a>) => void | Set the log level shown to the user as alert dialogs. |
124
118
125
-
126
119
#### OneSignalUserAPI
127
120
128
121
Current-user operations exposed via `OneSignal.User`.
@@ -153,22 +146,19 @@ Current-user operations exposed via `OneSignal.User`.
153
146
|**getExternalId**| () => Promise<string \| null>| Get the external ID set via `login`, or null if the user is anonymous. |
154
147
|**trackEvent**| (name: string, properties?: object \| undefined) => Promise<void>| Track a custom event with an optional set of JSON-serializable properties. |
Outcome reporting exposed via `OneSignal.Session`.
@@ -315,7 +291,6 @@ Outcome reporting exposed via `OneSignal.Session`.
315
291
|**addUniqueOutcome**| (name: string) => Promise<void>| <ahref="#record">Record</a> a unique outcome with the given name against the current session. |
316
292
|**addOutcomeWithValue**| (name: string, value: number) => Promise<void>| <ahref="#record">Record</a> an outcome with the given name and value against the current session. |
317
293
318
-
319
294
#### OneSignalLocationAPI
320
295
321
296
Location permission and sharing exposed via `OneSignal.Location`.
@@ -326,7 +301,6 @@ Location permission and sharing exposed via `OneSignal.Location`.
326
301
|**setShared**| (shared: boolean) => void | Enable or disable sharing the device location with OneSignal. |
327
302
|**isShared**| () => Promise<boolean>| Whether the device location is currently shared with OneSignal. |
328
303
329
-
330
304
#### OneSignalLiveActivitiesAPI
331
305
332
306
Live activity controls exposed via `OneSignal.LiveActivities`. iOS only unless noted.
@@ -340,56 +314,48 @@ Live activity controls exposed via `OneSignal.LiveActivities`. iOS only unless n
340
314
|**setupDefault**| (options?: <ahref="#liveactivitysetupoptions">LiveActivitySetupOptions</a> \| undefined) => Promise<void>| Set up the OneSignal default live activity, optionally enabling pushToStart/pushToUpdate. |
341
315
|**startDefault**| (activityId: string, attributes: <ahref="#record">Record</a><string, unknown>, content: <ahref="#record">Record</a><string, unknown>) => Promise<void>| Start a live activity backed by the OneSignal default attributes type. |
The setup options for `OneSignal.LiveActivities.setupDefault`.
392
358
393
-
<code>{ /*** When true, OneSignal will listen for pushToStart tokens for the `OneSignalLiveActivityAttributes` structure. */ enablePushToStart: boolean; /*** When true, OneSignal will listen for pushToUpdate tokens for each start live activity that uses the *`OneSignalLiveActivityAttributes` structure. */ enablePushToUpdate: boolean; }</code>
359
+
<code>{ /**_ When true, OneSignal will listen for pushToStart tokens for the `OneSignalLiveActivityAttributes` structure. _/ enablePushToStart: boolean; /**_ When true, OneSignal will listen for pushToUpdate tokens for each start live activity that uses the _`OneSignalLiveActivityAttributes` structure. \*/ enablePushToUpdate: boolean; }</code>
![github-actions[bot]](https://github.githubassets.com/images/gravatars/gravatar-user-420.png?size=40){kind=avatar}
0 commit comments