Skip to content

Commit 596e5f7

Browse files
authored
Merge pull request #142 from nanoapi-io/feature/refactoring-prepare-for-stackcore
refactoring to prepare for stackcore
2 parents 020688c + 5c7b316 commit 596e5f7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+3235
-3633
lines changed

README.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ determinstic tool.
5050
`napi` aims to support all major programming languages. Here is the current
5151
status:
5252

53-
| Language/Framework | Status | Related Issues |
54-
| ------------------ | -------------- | --------------------------------------------------- |
55-
| Python | ✅ Supported | [#28](https://github.com/nanoapi-io/napi/issues/28) |
56-
| C# | ✅ Supported | [#31](https://github.com/nanoapi-io/napi/issues/31) |
57-
| PHP | 🚧 In Progress | [#30](https://github.com/nanoapi-io/napi/issues/30) |
58-
| Java | 🚧 In Progress | [#32](https://github.com/nanoapi-io/napi/issues/32) |
59-
| C | 🚧 In Progress | Not Tracked Yet |
60-
| C++ | 🚧 In Progress | Not Tracked Yet |
61-
| JavaScript | 🚧 In Progress | Not Tracked Yet |
62-
| TypeScript | 🚧 In Progress | Not Tracked Yet |
53+
| Language/Framework | Status |
54+
| ------------------ | -------------- |
55+
| Python | ✅ Supported |
56+
| C# | ✅ Supported |
57+
| C | In Progress |
58+
| Java | 🚧 In Progress |
59+
| C++ | 🚧 In Progress |
60+
| PHP | 🚧 In Progress |
61+
| JavaScript | 🚧 In Progress |
62+
| TypeScript | 🚧 In Progress |
6363

6464
For the latest updates, visit our [project board](/projects).
6565

@@ -104,17 +104,30 @@ Initialize the project. This step is required before running any other command.
104104
This will create a .napirc configuration file in the project root, storing paths
105105
and settings necessary for further commands.
106106

107-
### `napi audit view`
107+
### `napi manifest generate`
108108

109-
Scan and audit your codebase for potential improvements, vulnerabilities, and
110-
maintainability issues. This command opens the NanoAPI UI in your default
111-
browser, providing a clear overview of what areas of your code would benefit
112-
most from refactoring or cleanup.
109+
Generate a manifest of your codebase that captures its structure, dependencies,
110+
and relationships. This command analyzes your code and writes the manifest data
111+
to the configured `napi_out` directory in your project.
113112

114-
> **Important**: Run napi audit view periodically, especially before major
115-
> refactoring efforts, to ensure your code is in good shape. It will soon also
116-
> be possible to integrate that command into CI/CD workflows to catch
117-
> architectural-level-quality issues early.
113+
### `napi manifest view`
114+
115+
Open the NanoAPI UI in your default browser to visualize and explore the
116+
manifest generated by `napi manifest generate`. This provides an interactive
117+
view of your codebase's architecture, helping you identify areas for potential
118+
improvements and refactoring.
119+
120+
### `napi extract`
121+
122+
Extract specific symbols (functions, classes, etc.) from your codebase into
123+
separate files. Use the format `--symbol file|symbol` where file is the path
124+
relative to your project root and symbol is the name to extract. The UI can
125+
generate these commands for convenient copy-pasting when browsing your code.
126+
127+
> **Important**: Run `napi manifest generate` whenever you make significant
128+
> changes to your codebase to ensure your manifest stays up-to-date. The
129+
> manifest data can be integrated into CI/CD workflows to track architectural
130+
> changes over time.
118131
119132
## CI/CD Integration
120133

0 commit comments

Comments
 (0)