Allow functionList

functionList schema already existed, but enable it in XML validator add the functionList attributes to udl.schema and add functionList to the JSON->MD validator+generator script update instructions to include optional functionList and to describe the new JSON fields
notepad-plus-plus · May 17, 2024 · e1fc9bf · e1fc9bf
1 parent ac856ef
commit e1fc9bf
Show file tree

Hide file tree

Showing 6 changed files with 99 additions and 6 deletions.
diff --git a/.github/workflows/CI_build.yml b/.github/workflows/CI_build.yml
@@ -15,7 +15,7 @@ jobs:
       working-directory: .
       run: python -m pip install -r requirements.txt
 
-    - name: Validate xml of UDLs and autoCompletions folders
+    - name: Validate folders of XML types (UDLs, autoCompletion, functionList)
       working-directory: .
       run: python .validators\validator_xml.py
 

diff --git a/.validators/udl.schema b/.validators/udl.schema
@@ -66,6 +66,16 @@
 				"autoCompletionAuthor": {
 					"type": "string",
 					"minLength": 1
+				},
+				"functionList": {
+					"oneOf": [
+						{ "type": "boolean" },
+						{ "type": "string", "minLength": 1}
+					]
+				},
+				"functionListAuthor": {
+					"type": "string",
+					"minLength": 1
 				}
 			}
 		}

diff --git a/.validators/validator_json.py b/.validators/validator_json.py
@@ -71,6 +71,7 @@ def gen_pl_table(filename):
     tab_text += tmpl_tab_head
 
     ac_list = []
+    fl_list = []
 
     # UDL Name = (ij.display-name)ij.id-name.xml or repolink
     # Author = ij.author
@@ -150,12 +151,55 @@ def gen_pl_table(filename):
                 else:
                     ac_list.append(tmpl_tr_b + "[" + udl["display-name"] +"](" + ac_link + ")" + tmpl_td + author + tmpl_td + udl["description"] + tmpl_tr_e)
 
+
+        # if this entry has functionList defined, add it to the list of functionLists
+        if "functionList" in udl:
+            if udl["functionList"]:
+                if str(udl["functionList"]) == "True":
+                    fl_link = udl["id-name"] + ".xml"
+                elif udl["functionList"][0:4] == "http":
+                    fl_link = udl["functionList"]
+                else:
+                    fl_link = str(udl["functionList"]) + ".xml"
+
+                # print(f'functionList: {udl["functionList"]} => {fl_link}')
+                # absolute path for existence testing
+                fl_link_abs  = Path(os.path.join(os.getcwd(),"functionList", fl_link))
+
+                # relative path for correct linking
+                fl_link = "./functionList/%s" % (fl_link)
+
+                # TODO: use functionListAuthor field if the functionList has a different author than the UDL (like for RenderMan)
+                if "functionListAuthor" in udl:
+                    if udl["functionListAuthor"]:
+                        author = udl["functionListAuthor"]
+                        mailto = ""
+                        if ' <mailto:' in udl["functionListAuthor"]:
+                            p = udl["functionListAuthor"].find(' <mailto:')
+                            m = p + 2
+                            e = udl["functionListAuthor"].find('>', p)
+                            mailto = udl["functionListAuthor"][m:e]
+                            author = udl["functionListAuthor"][:p]
+
+                # append to list if it exists, otherwise give error
+                if not ("http:" in fl_link or "https:" in fl_link) and not fl_link_abs.exists():
+                    print(f'fl_link = {fl_link}')
+                    post_error(f'{udl["display-name"]}: functionList file missing from repo: JSON id-name expects it at filename="{fl_link}"')
+                else:
+                    fl_list.append(tmpl_tr_b + "[" + udl["display-name"] +"](" + fl_link + ")" + tmpl_td + author + tmpl_td + udl["description"] + tmpl_tr_e)
+
     # add the Auto-Completion Definitions in a separate table at the end
     tab_text += tmpl_new_line
     tab_text += "## Auto-Completion Definitions%s%s" % (tmpl_new_line, tmpl_new_line)
     tab_text += tmpl_tab_head
     tab_text += tmpl_new_line.join(ac_list)
 
+    # add the FunctionList Definitions in a separate table at the end
+    tab_text += tmpl_new_line
+    tab_text += "## FunctionList Definitions%s%s" % (tmpl_new_line, tmpl_new_line)
+    tab_text += tmpl_tab_head
+    tab_text += tmpl_new_line.join(fl_list)
+
     # always end the file with a newline
     tab_text += tmpl_new_line
 
@@ -261,6 +305,31 @@ def parse(filename):
                     print(f'-> also confirmed "autoCompletions/{ac_link}"')
 
 
+        # look at optional functionList
+        if "functionList" in udl:
+            # print(f'\tfunctionList: {udl["functionList"]}')
+            if udl["functionList"]:
+                if str(udl["functionList"]) == "True":
+                    fl_link = udl["id-name"] + ".xml"
+                elif udl["functionList"][0:4] == "http":
+                    fl_link = udl["functionList"]
+                else:
+                    fl_link = str(udl["functionList"]) + ".xml"
+                fl_link_abs  = Path(os.path.join(os.getcwd(),"functionList", fl_link))
+
+                if fl_link[0:4] == "http":
+                    try:
+                        response = requests.get(fl_link)
+                        print(f'-> also confirmed functionList URL: {fl_link}')
+                    except requests.exceptions.RequestException as e:
+                        post_error(str(e))
+                        continue
+                elif not fl_link_abs.exists():
+                    post_error(f'{udl["display-name"]}: functionList file missing from repo: JSON id-name expects it at filename="functionList/{fl_link}"')
+                else:
+                    print(f'-> also confirmed "functionList/{fl_link}"')
+
+
 parse("udl-list.json")
 with open("udl-list.md", "w", encoding="utf8") as md_file:
     md_file.write(gen_pl_table("udl-list.json"))

diff --git a/.validators/validator_xml.py b/.validators/validator_xml.py
@@ -115,8 +115,16 @@ def parse_xml_files_from_autoCompletions_dir():
             #print(os.path.join("autoCompletions", file))
             parse_xml_file(os.path.join("autoCompletions", file), '.validators/autoCompletion.xsd')
 
+def parse_xml_files_from_functionList_dir():
+
+    for file in os.listdir("functionList"):
+        if file.endswith(".xml"):
+            #print(os.path.join("functionList", file))
+            parse_xml_file(os.path.join("functionList", file), '.validators/functionList.xsd')
+
 parse_xml_files_from_udls_dir()
 parse_xml_files_from_autoCompletions_dir()
+parse_xml_files_from_functionList_dir()
 
 if has_error:
     sys.exit(-2)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,8 @@
 The goal of this Collection is to provide a UDL center for users who need the programming languages which are not supported directly by Notepad++. Any UDL author can submit their UDL (with an explicit name - "id-name") in `UDLs` directory so users can find what they want from `UDLs` directory very easily.  When submitting a UDL to the Collection, the author may either upload the XML file, or just supply a link their own repository's copy of the UDL definition XML file.
 
-You may also optionally submit an Auto-Completion definition to go with your UDL (or to go with someone else's UDL).
+You may also optionally submit an Auto-Completion definition and/or a Function List definition to go with your UDL (or to go with someone else's UDL).
 
-To submit a UDL and/or autoCompletion definition, you have to modify [udl-list.json](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.json), then submit a Pull Request to add it to the Collection. The team will review your submission, and either merge it into the Collection, ask for clarification or fixes, or reject the submission.  (The [udl-list.md](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.md), which you used to also have to edit, is now auto-generated to save effort and maintain consistency.)
+To submit a UDL and/or autoCompletion definition and/or functionList definition, you have to modify [udl-list.json](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.json), then submit a Pull Request to add it to the Collection. The team will review your submission, and either merge it into the Collection, ask for clarification or fixes, or reject the submission.  (The [udl-list.md](https://github.com/notepad-plus-plus/userDefinedLanguages/blob/master/udl-list.md), which you used to also have to edit, is now auto-generated to save effort and maintain consistency.)
 
 
 ## Some rules and recommendation of submission
@@ -23,6 +23,7 @@ To be accepted, your submission _must_ meet the following **requirement**s and _
 6. **recommendation**: in your Pull Request, please provide a link to a public description of the language your UDL is based on (which will help to establish the general-interest nature of the UDL), as well as a link to an example file in that language (so that the UDL can be verified as functional).
    * If you have an example file, you can upload it to the `UDL-samples` folder of the repository. Please have this file use the same name as your UDL definition file, but with the appropriate file extension, rather than `.xml`.  Example: `UDLs\STL_udl.byPryrt.xml` would have a corresponding example file `UDL-samples\STL_udl.byPryrt.stl`.
 7. **recommendation**: if you have also created an [autoCompletion file](https://npp-user-manual.org/docs/auto-completion/) for your UDL, you may add it in the `autoCompletions` folder before you submit your PR, using a similar naming scheme to the UDL's XML filename.
+8. **recommendation**: if you have also created a [functionList definition](https://npp-user-manual.org/docs/function-list/) for your UDL, you may add it in the `functionList` folder before you submit your PR, using a similar naming scheme to the UDL's XML filename.
 
 ## Edit `udl-list.json`
 
@@ -40,11 +41,11 @@ When you make a submission, you should edit the [udl-list.json](https://github.c
     - If it is `false` or not supplied, then it indicates there is no autoCompletion file in the submission.
 - The `autoCompletionAuthor` attribute should be set to the name of the author of the autoCompletion definition, if it's a different author than the UDL.
     - For example, the [RenderMan UDL](./UDLs/RenderMan-RSL_byStefanGustavson.xml) was written by Stefan Gustavson, but the [RenderMan autoCompletion](./autoCompletions/RenderMan-RSL_by-focus_gfx.xml) was supplied by focus_gfx, so `autoCompletionAuthor` is set in order to give proper credit to both.
-- COMING SOON: The `functionList` attribute should be included if you are supplying a functionList definition file.  It can either be a Boolean (`true` or `false`), or it can be a string.
+- The `functionList` attribute should be included if you are supplying a functionList definition file.  It can either be a Boolean (`true` or `false`), or it can be a string.
     - If it's `true`, then it will use the same file name as the UDL's .xml, but in the `functionList/` directory instead of the `UDLs/` directory.
     - If it's a string, it can either be the name of the functionList file (without the `.xml`, similar to the `id-name` entry), or the URL to the external file (similar to the `repository` attribute).
     - If it is `false` or not supplied, then it indicates there is no functionList definition file in the submission.
-- COMING SOON: The `functionListAuthor` attribute should be set to the name of the author of the functionList definition, if it's a different author than the UDL.
+- The `functionListAuthor` attribute should be set to the name of the author of the functionList definition, if it's a different author than the UDL.
     - The `functionListAuthor` is set in order to give proper credit to both, even if they are made to work together.
 
 ## Validation
@@ -64,7 +65,7 @@ Since many contributors are not GitHub experts, we have added in this section to
 3. Make your changes:
    - Upload the UDL's XML file to the UDL folder _in your fork_, named per the rules defined above
    - Optionally add the UDL's auto-completion XML file in the autoCompletions folder _in your fork_, named per the rules above
-   - COMING SOON: Optionally add the UDL's functionList definition XML file in the functionList folder _in your fork_, named per the rules above
+   - Optionally add the UDL's functionList definition XML file in the functionList folder _in your fork_, named per the rules above
    - Edit the `udl-list.json` _in your fork_, per the rules defined above
 4. Create a PR from your fork
     - from your fork's master branch, after you've made the changes above,

diff --git a/udl-list.md b/udl-list.md
@@ -360,3 +360,8 @@
 | [smali](./autoCompletions/smali_by_enjoyop.xml) | Enjoyop | Smali Language identification and autocompletion |
 | [Smartsheet](./autoCompletions/Smartsheet_byKevinDickinson.xml) | [Kevin Dickinson](mailto:[email protected]) | Smartsheet |
 | [Vim script](./autoCompletions/Vimscript_by_rdipardo.xml) | [Robert Di Pardo](https://gist.github.com/rdipardo/0b78f62e1ce481ff0d8f8e80cc298ced) | User Defined Language for Vim script |
+## FunctionList Definitions
+
+| Name | Author | Description |
+|-----|--------|-------------|
+