Skip to content

Clarify helper functions must be separate private functions#72

Merged
Marius Storhaug (MariusStorhaug) merged 4 commits into
mainfrom
docs-function-structure
Jul 19, 2026
Merged

Clarify helper functions must be separate private functions#72
Marius Storhaug (MariusStorhaug) merged 4 commits into
mainfrom
docs-function-structure

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Summary

  • add an explicit module standard that helper logic must not be defined as nested/internal helper functions
  • require helper logic to be implemented as separate private function files under src/functions/private//

Why

This keeps function structure consistent with the one-function-per-file model and makes helpers reusable and testable.

Document that helper logic must be implemented as separate private function files rather than nested/internal helper functions.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Move the nested helper guidance from the private-functions section to general layout rules so it clearly applies to all functions.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Update the no-nested-functions rule to require explicitly deciding whether extracted functions are private internals or public API.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit ece10f3 into main Jul 19, 2026
21 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs-function-structure branch July 19, 2026 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant