Skip to content

Atisa 141 label generated files#1

Merged
not-fritos merged 3 commits intomainfrom
atisa-141-label_generated_files
Jun 26, 2025
Merged

Atisa 141 label generated files#1
not-fritos merged 3 commits intomainfrom
atisa-141-label_generated_files

Conversation

@not-fritos
Copy link
Copy Markdown
Member

@not-fritos not-fritos commented Jun 3, 2025

To prevent writing changes to generated files (and thus losing edits), we should label at the top of generated files to mention they're generated.

https://github.com/codewithher/Atisa-SSOT/issues/141

@not-fritos not-fritos requested a review from Copilot June 3, 2025 01:17

This comment was marked as outdated.

@not-fritos
Copy link
Copy Markdown
Member Author

update the description to pxtarget.json libs instead of targetconfig.json

@not-fritos not-fritos marked this pull request as draft June 13, 2025 19:27
@not-fritos not-fritos marked this pull request as ready for review June 13, 2025 19:27
@not-fritos not-fritos requested a review from Copilot June 13, 2025 19:28
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a banner to generated files in order to prevent accidental edits. Key changes include a version bump in package.json and updating the CLI to prepend a generated file declaration to the projects markdown file.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
package.json Updated version from "11.4.7" to "11.4.8".
cli/cli.ts Added GENERATED_FILE_DECLARATION and updated markdown generation for projects.md including proper newline formatting.
Comments suppressed due to low confidence (1)

cli/cli.ts:1964

  • The SUMMARY.md file is generated but does not include the generated file declaration. Consider prepending it with the GENERATED_FILE_DECLARATION to warn against manual edits.
nodeutil.writeFileSync(path.join(docsRoot, "docs/projects/SUMMARY.md"), tocmd, { encoding: "utf8" });

@not-fritos not-fritos requested a review from kylie-taitano June 17, 2025 01:17
@kylie-taitano
Copy link
Copy Markdown

LGTM!

@not-fritos not-fritos merged commit e14d375 into main Jun 26, 2025
6 of 9 checks passed
@not-fritos not-fritos deleted the atisa-141-label_generated_files branch June 26, 2025 00:27
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.

3 participants