Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[project] Add API docs for each project #136

Merged
merged 26 commits into from
Jul 10, 2024
Merged

[project] Add API docs for each project #136

merged 26 commits into from
Jul 10, 2024

Conversation

Alchez
Copy link
Collaborator

@Alchez Alchez commented Jun 26, 2024 •
edited
Loading

Changelist:

  • Update .gitignore to latest version suggested by Rush
  • Add Heft tooling to the Stonecrop monorepo
    • Includes a Typescript plugin to run for all projects
    • Includes API Extractor for auto-generating API structure
    • Includes API Documenter to convert auto-generated API into documentation
  • Move package stories into the examples folder to avoid dependency issues (eg. aform <-> atable circular dependency)
  • Added ESLint fixes

Todo:

  • Add package documentation

@Alchez Alchez force-pushed the fix-stonecrop-typings branch 2 times, most recently from c6f0960 to d89a0fb Compare June 26, 2024 11:36
@Alchez Alchez force-pushed the fix-stonecrop-typings branch from d89a0fb to 2a714ca Compare June 26, 2024 11:44
@Alchez Alchez linked an issue Jun 27, 2024 that may be closed by this pull request
[docs] Automatic API discovery #70
Closed
@Alchez Alchez changed the title [project] allow typings to be used for each project [project] [WIP] allow typings to be used for each project Jun 27, 2024
@Alchez Alchez force-pushed the fix-stonecrop-typings branch from 9559c0e to 74fd755 Compare July 1, 2024 07:55
@Alchez Alchez force-pushed the fix-stonecrop-typings branch from 7ccb72d to 3778d61 Compare July 1, 2024 11:53
@agritheory agritheory marked this pull request as draft July 8, 2024 12:59
@agritheory agritheory changed the title [project] [WIP] allow typings to be used for each project [project] Allow typings to be used for each project Jul 8, 2024
@agritheory agritheory changed the title [project] Allow typings to be used for each project [project] Add API docs for each project Jul 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 9, 2024 •
edited
Loading

Coverage Report for ./aform

Status Category Percentage Covered / Total
🟢 Lines 90.47% (🎯 70%) 209 / 231
🟢 Statements 90.59% (🎯 70%) 212 / 234
🟢 Functions 87.5% (🎯 70%) 42 / 48
🟢 Branches 74.44% (🎯 70%) 67 / 90
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
aform/src/components/AForm.vue 90.47% 40% 85.71% 90.47% 41-43, 42
aform/src/components/form/ACheckbox.vue 100% 100% 100% 100%
aform/src/components/form/ADropdown.vue 91.83% 76.92% 84.61% 91.83% 55, 84-85, 93
aform/src/components/form/AFieldset.vue 90% 100% 50% 90% 8
aform/src/components/form/ANumericInput.vue 100% 100% 100% 100%
aform/src/components/form/ATextInput.vue 100% 100% 100% 100%
aform/src/directives/mask.ts 84.09% 59.09% 100% 83.72% 33-34, 41, 50, 65, 98, 103
Unchanged Files
aform/src/components/base/CollapseButton.vue 100% 100% 100% 100%
aform/src/components/form/AComboBox.vue 0% 100% 0% 0% 2-1, 7-3
aform/src/components/form/ADate.vue 85.71% 50% 100% 85.71% 42
aform/src/components/form/ADatePicker.vue 96.61% 90% 92.85% 96.49% 65, 27
aform/src/components/utilities/Login.vue 88.88% 81.81% 100% 88.88% 82-84
Generated in workflow #285

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 9, 2024 •
edited
Loading

Coverage Report for ./atable

Status Category Percentage Covered / Total
🟢 Lines 73.65% (🎯 70%) 123 / 167
🟢 Statements 73.25% (🎯 70%) 126 / 172
🟢 Functions 72.72% (🎯 70%) 24 / 33
🔴 Branches 48.48% (🎯 70%) 64 / 132
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
atable/src/components/ACell.vue 94.64% 56.75% 100% 94.64% 65, 105-108, 159
atable/src/components/AExpansionRow.vue 0% 0% 0% 0% 22, 35-37, 39-41, 40, 43-62, 44-50, 46-48, 52-54, 53, 56-61, 1, 3
atable/src/components/ARow.vue 63.63% 57.14% 60% 63.63% 56, 63, 67, 71, 73-78, 74-77, 80-85, 12
atable/src/components/ATable.vue 88.46% 46.15% 100% 91.66% 155-157, 156, 156
atable/src/components/ATableHeader.vue 100% 50% 100% 100%
atable/src/components/index.ts 65.9% 50% 66.66% 66.66% 47-49, 48, 61, 84-86, 85, 104-116, 105-113, 106-112, 108-111, 110, 114-116, 115
Unchanged Files
atable/src/components/ATableModal.vue 50% 100% 0% 50% 29
Generated in workflow #285

@Alchez Alchez force-pushed the fix-stonecrop-typings branch from eb16ab5 to 04e5ee6 Compare July 9, 2024 10:30
@Alchez Alchez marked this pull request as ready for review July 10, 2024 10:34
@Alchez
Copy link
Collaborator Author

Alchez commented Jul 10, 2024

@agritheory This PR is ready for review. The whole monorepo needs more user documentation, but this should be a good start.

@Alchez Alchez requested a review from agritheory July 10, 2024 10:35
@agritheory agritheory merged commit de8432b into development Jul 10, 2024
5 of 6 checks passed
@Alchez Alchez deleted the fix-stonecrop-typings branch July 10, 2024 12:43
@Alchez Alchez mentioned this pull request Nov 7, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agritheory agritheory agritheory approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Automatic API discovery
2 participants
@Alchez @agritheory