Add Lua rockspec package handler for LuaRocks dependencies by SLASH217 · Pull Request #4743 · aboutcode-org/scancode-toolkit

SLASH217 · 2026-02-13T16:29:35Z

Add Lua rockspec package handler for LuaRocks dependencies

Changes

Added RockspecHandler class for .rockspec file detection
Implemented RockspecParser using Lua AST parsing with luaparser library
Extracts package metadata: name, version, description, license, homepage_url, vcs_url (non-exhaustive list)
Integrated handler into APPLICATION_PACKAGE_DATAFILE_HANDLERS registry
Added 23 comprehensive unit and integration tests
Fixed dead documentation links in CONTRIBUTING.rst

Tasks

Reviewed contribution guidelines
PR is descriptively titled 📑 and links the original issue above 🔗
Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
Run tests locally to check for errors.
Commits are in uniquely-named feature branch and has no merge conflicts 📁
Updated documentation pages (if applicable)
Updated CHANGELOG.rst (if applicable)

Signed-off-by: Prashanna Dahal prashanna217@gmail.com

Implement base handler class and Lua rockspec parser using luaparser for AST-based dependency extraction. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Extract package metadata and dependencies from rockspec files with version specification parsing. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

* Test parser with real Kong rockspec file * Test handler integration with patterns Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Register handler in APPLICATION_PACKAGE_DATAFILE_HANDLERS to enable automatic .rockspec file detection. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

* Update contributing-docs link to new structure * Ensure both documentation links work correctly * Point to getting-started/contribute path Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Change luaparser from == to match project's version pinning pattern: * requirements.txt: luaparser==1.4.3 (exact pinning) * setup.cfg: luaparser == 1.4.3 (exact pinning) Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

- This was causing a test to fail in CI/CD Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

- Extra "/n" causing failure of CI/CD Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

AyanSinhaMahapatra

Thanks++ @SLASH217 for the PR, looking good already, but you need to modify the tests so we can see the full output and verify the functionality added before I can do an in depth review. Added some other feedback you also need to address.

AyanSinhaMahapatra · 2026-02-18T09:47:46Z

+        parser = rockspec.RockspecParser(test_file)
+        data = parser.parse()
+
+        assert data['rockspec_format'] == '3.0'


This is not how we write tests for package manifest parsers, asserting the data one by one. Instead we dump the whole results in a JSON file and check the output matches to it, so we can see the entire output and test it, and not just some fields. And this result is more readable, and for changes we can regen and check the changes in output.
This is done using tests.packagedcode.packages_test_utils.Packagetester.check_packages_data()

See how this is done in all other test files for package manifest parsers, for example:

scancode-toolkit/tests/packagedcode/test_pypi.py

Line 163 in 022ddc8

self.check_packages_data(package, expected_loc, regen=REGEN_TEST_FIXTURES)

AyanSinhaMahapatra · 2026-02-18T09:49:41Z

+build = {
+  type = "builtin",
+  modules = {
+    ["kong"] = "kong/init.lua",


AFAIK we are not parsing/storing the modules info here and this is increasing the test file size without contributing anything to the test, can you remove these modules from all the tests?

Same for all non essential things in other test files.

I have removed the unnecessary bloat from the test files.

AyanSinhaMahapatra · 2026-02-18T09:50:37Z

@@ -0,0 +1,530 @@
+package = "kong"


Would be great to add the link to this test file (and all others) as a comment, since these are real files(?) and we should provide where we got them from

Added the source of the rockspec files in test_file_source.txt.

AyanSinhaMahapatra · 2026-02-18T10:07:05Z

+            - name: Package name
+            - version_number: Clean version number (e.g. "3.1.3") or None
+            - version_spec: Full version specification with operator (e.g. "== 3.1.3") or None
+            - raw: Original input string


Not sure why you want to pass back the input, don't we already have this in context?

AyanSinhaMahapatra · 2026-02-18T10:08:49Z

+            package_name: Name of the package
+            package_version: Optional version string (without operators)
+
+        Returns:


This is additional information you're conveying twice, and not how we write the docstrings. Just describe the output, what it does and the inputs in a short to-the-point docstring. For all the functions

AyanSinhaMahapatra · 2026-02-18T10:10:05Z

+            extra_data['supported_platforms'] = platforms
+
+        # Future fields can be added here
+        # e.g., build_backend, build_requires, etc.


Why not just add these now? And if you're keeping work for later, add a TODO:

AyanSinhaMahapatra · 2026-02-18T10:12:38Z

    jsonstreams >= 0.5.0
    license_expression >= 30.4.4
    lxml >= 5.4.0
+    luaparser == 4.0.0


Let's not pin dependencies, you can add this as a lower bound. We are a library too :)

Understood! Will keep in mind for future commits.

SLASH217 · 2026-02-19T17:19:49Z

Thank you for your feedback and valuable time.
I will diligently make the updates and push as soon as possible.

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

-- Added links for source of .rockspec files used in testing. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

-- Modules not required to be parsed Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

-- updated to be lower bound Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

-- use check_packages_data -- instead of manually asserting data one by one. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

-- Causing the CI/CD to fail. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 · 2026-02-21T16:49:08Z

@AyanSinhaMahapatra I have updated the PR, adding all the fixes you have requested.
Please do review it!

AyanSinhaMahapatra

Thanks @SLASH217, almost there. A couple small changes suggested for your consideration.

Could you also check if #3249 is fixed by this? See #3249 (comment) for the input.

AyanSinhaMahapatra · 2026-04-09T16:32:20Z

+
+description = {
+    summary = "A fast JSON encoding/parsing module",
+    detailed = [[


Please also parse and append the detailed description.

AyanSinhaMahapatra · 2026-04-09T16:37:44Z

@@ -0,0 +1,11 @@
+Test File : Source


Would be best to include this in the .rockspec files itself, as comments are supported.

-- This is a single-line comment --[[ This is a multi-line comment describing the build process. ]]

AyanSinhaMahapatra · 2026-04-09T16:38:18Z

@@ -0,0 +1,11 @@
+Test File : Source
+
+1. test.rockspec : https://github.com/openresty/lua-cjson/blob/master/lua-cjson-2.1.0.16-1.rockspec


instead of test in filenames, use the package names, this is more verbose.

AyanSinhaMahapatra · 2026-04-09T16:39:33Z

+if __name__ == '__main__':
+    import pytest
+    pytest.main([__file__, '-v'])


not required, please remove.

AyanSinhaMahapatra · 2026-04-15T11:47:10Z

+      },
+      {
+        "purl": "pkg:luarocks/luaxxhash@1.0",
+        "extracted_requirement": ">= 1.0",


In case where the extracted requirement is not pinned, we should not include the version in the purl. As this is not the resolved version, only a requirement, actual version may be different.

AyanSinhaMahapatra · 2026-04-15T12:02:43Z

+        assert len(handlers) == 1, f"Expected 1 RockspecHandler, found {len(handlers)}"
+        assert handlers[0] == rockspec.RockspecHandler
+
+    def test_handler_in_datasource_registry(self):


How is this test really different from the test above, is this checking something new?
HANDLER_BY_DATASOURCE_ID is computed from the handlers lists

AyanSinhaMahapatra · 2026-04-15T12:03:26Z

+luaparser==4.0.0
 MarkupSafe==3.0.3
 more-itertools==10.8.0
+multimethod==2.0.2


scanned the new dependencies, looks safe to add

SLASH217 · 2026-04-19T20:19:27Z

Understood! I will get to work as soon my exams end.

Prashanna Dahal added 5 commits February 13, 2026 14:04

Add RockspecHandler base and parser

f9324f8

Implement base handler class and Lua rockspec parser using luaparser for AST-based dependency extraction. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Implement parser logic in handler

af15759

Extract package metadata and dependencies from rockspec files with version specification parsing. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Add unit tests for RockspecHandler

d106e92

* Test parser with real Kong rockspec file * Test handler integration with patterns Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Integrate RockspecHandler into __init__

dc4fc99

Register handler in APPLICATION_PACKAGE_DATAFILE_HANDLERS to enable automatic .rockspec file detection. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix dead documentation links

99cd99f

* Update contributing-docs link to new structure * Ensure both documentation links work correctly * Point to getting-started/contribute path Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 force-pushed the support_rockspec branch from 35fb9e2 to c84c872 Compare February 13, 2026 16:49

Fix luaparser version specifier aboutcode-org#3526

3b359de

Change luaparser from == to match project's version pinning pattern: * requirements.txt: luaparser==1.4.3 (exact pinning) * setup.cfg: luaparser == 1.4.3 (exact pinning) Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 force-pushed the support_rockspec branch from c84c872 to 3b359de Compare February 13, 2026 16:57

Prashanna Dahal added 3 commits February 14, 2026 17:47

Add LuaRocks rockspec package handler to plugins list.

9a0cd5f

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix auto-formatter changes in .txt file

4103a81

- This was causing a test to fail in CI/CD Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix auto-formatter changes in .txt file

d7b5fbd

- Extra "/n" causing failure of CI/CD Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

prabhu mentioned this pull request Feb 15, 2026

[lua] luarocks support cdxgen/cdxgen#3485

Open

AyanSinhaMahapatra requested changes Feb 18, 2026

View reviewed changes

AyanSinhaMahapatra reviewed Feb 18, 2026

View reviewed changes

Comment thread CONTRIBUTING.rst

AyanSinhaMahapatra added the need-changes PR needs to be updated with feedback label Feb 18, 2026

SLASH217 force-pushed the support_rockspec branch 3 times, most recently from 8bf9473 to 707adbc Compare February 20, 2026 21:06

Prashanna Dahal added 2 commits February 21, 2026 02:40

Fix updated docstrings to be clear and concise.

0dad109

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Add todo for parsing build table.

7a5e0ba

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 force-pushed the support_rockspec branch from 707adbc to 127f3fc Compare February 20, 2026 21:10

Prashanna Dahal added 6 commits February 21, 2026 02:43

Add test file source links.

9463a8b

-- Added links for source of .rockspec files used in testing. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix remove unparsed modules from test files

d7eef6c

-- Modules not required to be parsed Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Add transitive dependencies of luaparser

d8a00e5

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix unpin luaparser dependency

0d11d04

-- updated to be lower bound Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix tests to follow scancode format

f2eb2d7

-- use check_packages_data -- instead of manually asserting data one by one. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Fix auto-formatter changes in .txt file

21ca2ff

-- Causing the CI/CD to fail. Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 force-pushed the support_rockspec branch from 127f3fc to 21ca2ff Compare February 20, 2026 21:13

Fix plugins_list for formatter mistakes

d891a79

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

Missed one /n causing the ci/cd to fail

c843ee1

Signed-off-by: Prashanna Dahal <prashanna217@gmail.com>

SLASH217 requested a review from AyanSinhaMahapatra March 8, 2026 16:11

mstykow mentioned this pull request Mar 14, 2026

Support parsing: LuaRocks rockspec mstykow/provenant#103

Open

AyanSinhaMahapatra reviewed Apr 15, 2026

View reviewed changes

		@@ -0,0 +1,11 @@
		Test File : Source

		1. test.rockspec : https://github.com/openresty/lua-cjson/blob/master/lua-cjson-2.1.0.16-1.rockspec

Uh oh!

Conversation

SLASH217 commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!