citadel_cli 1.1.5 → 1.1.7
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 +1 -76
- package/dist/App.test.d.ts +1 -0
- package/dist/__test-utils__/factories.d.ts +0 -2
- package/dist/citadel.es.js +523 -484
- package/dist/citadel.umd.js +9 -9
- package/dist/components/Citadel/Citadel.d.ts +1 -0
- package/dist/components/Citadel/config/types.d.ts +1 -1
- package/dist/components/Citadel/hooks/useCitadelState.d.ts +0 -2
- package/dist/components/Citadel/hooks/useCommandHistory.d.ts +2 -2
- package/dist/components/Citadel/services/__tests__/HistoryService.test.d.ts +1 -0
- package/dist/components/Citadel/storage/StorageFactory.d.ts +1 -0
- package/dist/components/Citadel/storage/__tests__/StorageFactory.test.d.ts +1 -0
- package/dist/components/Citadel/types/__tests__/help-command.test.d.ts +1 -0
- package/dist/components/Citadel/types/__tests__/state.test.d.ts +1 -0
- package/dist/components/Citadel/types/command-registry.d.ts +8 -1
- package/dist/components/Citadel/types/state.d.ts +2 -0
- package/dist/examples/runtimeConfigCommands.d.ts +12 -0
- package/dist/examples/runtimeConfigDemo.d.ts +13 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -151,79 +151,4 @@ Then to make the component aware of them:
|
|
|
151
151
|
|
|
152
152
|
## Contributing
|
|
153
153
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
1. Clone the repository:
|
|
157
|
-
```bash
|
|
158
|
-
git clone https://github.com/jchilders/citadel_cli.git
|
|
159
|
-
cd citadel_cli
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
2. Install dependencies:
|
|
163
|
-
```bash
|
|
164
|
-
npm install
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
3. Build the package:
|
|
168
|
-
```bash
|
|
169
|
-
npm run build
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
4. (Optional but recommended) Link citadel so you can import it into a parallel project
|
|
173
|
-
```bash
|
|
174
|
-
npm link
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
5. (Optional) From the directory of the project you want to import Citadel into:
|
|
178
|
-
```bash
|
|
179
|
-
npm unlink citadel_cli && npm link citadel_cli
|
|
180
|
-
# ... your normal dev process ...
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
Load your appliation and press <kbd>.</kbd>
|
|
184
|
-
|
|
185
|
-
### Bug Reports and Feature Requests
|
|
186
|
-
|
|
187
|
-
- Use the GitHub Issues section to report bugs or suggest features
|
|
188
|
-
- Before creating a new issue, please check if a similar issue already exists
|
|
189
|
-
- Provide as much detail as possible in bug reports:
|
|
190
|
-
- Steps to reproduce the issue
|
|
191
|
-
- Expected behavior
|
|
192
|
-
- Actual behavior
|
|
193
|
-
- Browser/environment information
|
|
194
|
-
- Error messages or screenshots if applicable
|
|
195
|
-
|
|
196
|
-
### Development Process
|
|
197
|
-
|
|
198
|
-
1. Fork the repository
|
|
199
|
-
2. Create a new branch for your feature or bugfix:
|
|
200
|
-
```bash
|
|
201
|
-
git checkout -b feature/your-feature-name
|
|
202
|
-
# or
|
|
203
|
-
git checkout -b fix/your-bugfix-name
|
|
204
|
-
```
|
|
205
|
-
3. Make your changes
|
|
206
|
-
4. Write or update tests as needed
|
|
207
|
-
5. Run the test suite to ensure everything passes:
|
|
208
|
-
```bash
|
|
209
|
-
npm run test
|
|
210
|
-
```
|
|
211
|
-
6. Commit your changes with a clear and descriptive commit message
|
|
212
|
-
7. Push to your fork and submit a pull request
|
|
213
|
-
|
|
214
|
-
### Pull Request Guidelines
|
|
215
|
-
|
|
216
|
-
- Keep your changes focused. Submit separate pull requests for separate features/fixes
|
|
217
|
-
- Follow the existing code style and conventions
|
|
218
|
-
- Include tests for new functionality
|
|
219
|
-
- Update documentation as needed
|
|
220
|
-
- Ensure all tests pass
|
|
221
|
-
- Describe your changes in detail in the pull request description
|
|
222
|
-
|
|
223
|
-
### Code Style
|
|
224
|
-
|
|
225
|
-
- Follow TypeScript best practices
|
|
226
|
-
- Use meaningful variable and function names
|
|
227
|
-
- Comment complex logic or non-obvious code
|
|
228
|
-
- Keep functions focused and modular
|
|
229
|
-
- Use consistent formatting (the project uses ESLint and Prettier)
|
|
154
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on developing, testing, and releasing Citadel CLI.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -25,8 +25,6 @@ export declare const setupCitadelStateHook: () => {
|
|
|
25
25
|
hook: import('@testing-library/react').RenderHookResult<{
|
|
26
26
|
state: CitadelState;
|
|
27
27
|
actions: CitadelActions;
|
|
28
|
-
getAvailableCommands_s: () => string[];
|
|
29
|
-
getAvailableCommandSegments: () => CommandSegment[];
|
|
30
28
|
}, unknown>;
|
|
31
29
|
mockHistory: CommandHistory;
|
|
32
30
|
mockActions: CommandHistoryActions;
|