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

Remove comments from Lua code when bundle project #8187

Merged
merged 6 commits into from Oct 28, 2023
Merged

Remove comments from Lua code when bundle project #8187

merged 6 commits into from Oct 28, 2023

Conversation

AGulev
Copy link
Contributor

@AGulev AGulev commented Oct 27, 2023 •
edited

Remove all the comments from Lua code in all Lua files (*.lua, *.script etc) during the bundle process.

PR checklist

  • Code
    • Add engine and/or editor unit tests.
    • New and changed code follows the overall code style of existing code
    • Add comments where needed
  • Documentation
    • Make sure that API documentation is updated in code comments
    • Make sure that manuals are updated (in github.com/defold/doc)
  • Prepare pull request and affected issue for automatic release notes generator
    • Pull request - Write a message that explains what this pull request does. What was the problem? How was it solved? What are the changes to APIs or the new APIs introduced? This message will be used in the generated release notes. Make sure it is well written and understandable for a user of Defold.
    • Pull request - Write a pull request title that in a sentence summarises what the pull request does. Do not include "Issue-1234 ..." in the title. This text will be used in the generated release notes.
    • Pull request - Link the pull request to the issue(s) it is closing. Use on of the approved closing keywords.
    • Affected issue - Assign the issue to a project. Do not assign the pull request to a project if there is an issue which the pull request closes.
    • Affected issue - Assign the "breaking change" label to the issue if introducing a breaking change.
    • Affected issue - Assign the "skip release notes" is the issue should not be included in the generated release notes.

Example of a well written PR description:

  1. Start with the user facing changes. This will end up in the release notes.
  2. Add one of the GitHub approved closing keywords
  3. Optionally also add the technical changes made. This is information that might help the reviewer. It will not show up in the release notes. Technical changes are identified by a line starting with one of these:
    1. ### Technical changes
    2. Technical changes:
    3. Technical notes:
There was a anomaly in the carbon chroniton propeller, introduced in version 8.10.2. This fix will make sure to reset the phaser collector on application startup.

Fixes #1234

### Technical changes
* Pay special attention to line 23 of phaser_collector.clj as it contains some interesting optimizations
* The propeller code was not taking into account a negative phase.

@AGulev AGulev requested a review from britzl October 27, 2023 19:10
@AGulev
Merge branch 'dev' into remove-lua-comments
0a5ae63 
# Conflicts:
#	com.dynamo.cr/com.dynamo.cr.bob.test/src/com/dynamo/bob/pipeline/LuaScannerTest.java
#	com.dynamo.cr/com.dynamo.cr.bob/src/com/dynamo/bob/pipeline/LuaScanner.java
@AGulev
revert local changes
c34d8f5
@AGulev
minor fixes
133a3bb
AGulev
AGulev commented Oct 27, 2023
View reviewed changes
com.dynamo.cr/com.dynamo.cr.bob.test/src/com/dynamo/bob/pipeline/LuaScannerTest.java

int linesInFile = file.split("\r\n|\r|\n").length;
int linesAfterScanner = scanner.getParsedLua().split("\r\n|\r|\n").length;
assertEquals(linesInFile, linesAfterScanner);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make sure that after processing, we keep the same count of code lines

com.dynamo.cr/com.dynamo.cr.bob.test/src/com/dynamo/bob/pipeline/LuaScannerTest.java
for (String line : lines) {
result.append(line.trim()).append("\n");
}
return result.toString();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using of this function is a bit tricky. It's easier to take into account spaces in expected results

com.dynamo.cr/com.dynamo.cr.bob/src/com/dynamo/bob/pipeline/LuaScanner.java
ParseTreeWalker walker = new ParseTreeWalker();
walker.walk(this, parser.chunk());
String resultText = rewriter.getText();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's better to include the first rewriter.getText() call in TimeProfiler.

From documentation about rewriter:
https://www.antlr.org/api/JavaTool/org/antlr/v4/runtime/TokenStreamRewriter.html

You can insert stuff, replace, and delete chunks. Note that the operations are done lazily--only if you convert the buffer to a String with TokenStream.getText(). This is very efficient because you are not moving data around all the time. As the buffer of tokens is converted to strings, the getText() method(s) scan the input token stream and check to see if there is an operation at the current index. If so, the operation is done and then normal String rendering continues on the buffer. This is like having multiple Turing machine instruction streams (programs) operating on a single input tape. :)

britzl
britzl approved these changes Oct 28, 2023
View reviewed changes
Copy link
Contributor

@britzl britzl left a comment

Choose a reason for hiding this comment

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

Looks good.

@AGulev AGulev merged commit 44b07be into dev Oct 28, 2023
22 checks passed
@AGulev AGulev deleted the remove-lua-comments branch October 28, 2023 11:24
ultimanidev pushed a commit to ultimanidev/defold that referenced this pull request Nov 8, 2023
@AGulev @ultimanidev
Remove comments from Lua code when bundle project (defold#8187)
6b292fc
ultimanidev pushed a commit to ultimanidev/defold that referenced this pull request Nov 8, 2023
@AGulev @ultimanidev
Remove comments from Lua code when bundle project (defold#8187)
4a461cf
ultimanidev pushed a commit to ultimanidev/defold that referenced this pull request Nov 8, 2023
@AGulev @ultimanidev
Remove comments from Lua code when bundle project (defold#8187)
33e9465
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@britzl britzl britzl approved these changes

Assignees
No one assigned
Labels
None yet
Projects
No open projects
1.6.2
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@AGulev @britzl