You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by GitBox <gi...@apache.org> on 2022/09/20 17:29:24 UTC
[GitHub] [daffodil-vscode] stevedlawrence commented on a diff in pull request #240: Test suite updates
stevedlawrence commented on code in PR #240:
URL: https://github.com/apache/daffodil-vscode/pull/240#discussion_r975609468
##########
.github/workflows/CI.yml:
##########
@@ -110,6 +110,9 @@ jobs:
- run: $SBT compile # used to initialize sbt, if not done sbt universal:packageBin ran by yarn package times out -- windows only
if: runner.os == 'Windows'
- run: yarn install
- - run: yarn package
+ - run: yarn sbt
Review Comment:
Why the change from yarn package to yarn sbt? Dont' we sitll want to package to ensure the .vsix builds correctly?
##########
yarn.lock:
##########
@@ -8,22 +8,22 @@
integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==
"@grpc/grpc-js@^1.5.4":
- version "1.6.7"
- resolved "https://registry.yarnpkg.com/@grpc/grpc-js/-/grpc-js-1.6.7.tgz#4c4fa998ff719fe859ac19fe977fdef097bb99aa"
- integrity sha512-eBM03pu9hd3VqDQG+kHahiG1x80RGkkqqRb1Pchcwqej/KkAH95gAvKs6laqaHCycYaPK+TKuNQnOz9UXYA8qw==
Review Comment:
This is a lot of changes to the dependencies. Did you go through all of these and verify that the licenses are ASF compatible and if the LICENSE/NOTICE needs to be updated.
##########
src/language/providers/attributeCompletion.ts:
##########
@@ -28,38 +28,25 @@ import {
} from './utils'
import { attributeCompletion } from './intellisense/attributeItems'
+import { getCommonItems, createCompletionItem } from './utils'
function getCompletionItems(
itemsToUse: string[],
preVal: string = '',
additionalItems: string = ''
) {
- let compItems: vscode.CompletionItem[] = []
- let noPreVals: string[] = [
- 'dfdl:choiceBranchKey=',
- 'dfdl:representation',
- 'dfdl:choiceDispatchKey=',
- 'dfdl:simpleType',
- 'xs:restriction',
- ]
+ let compItems: vscode.CompletionItem[] = getCommonItems(
+ itemsToUse,
+ preVal,
+ additionalItems
+ )
+ compItems.forEach((i) =>
+ vscode.window.showInformationMessage(i.label.toString())
+ )
Review Comment:
Is this correct? This feels like some sort of debug output?
##########
package.json:
##########
@@ -1,480 +1,489 @@
{
- "name": "apache-daffodil-vscode",
- "displayName": "Apache Daffodil VS Code Extension",
- "description": "VS Code extension for Apache Daffodil DFDL schema debugging",
- "version": "1.1.0",
- "daffodilVersion": "3.3.0",
- "omegaEditServerHash": "ffabce0d095364d1c863466f522dfa0ac2f0574d6394a82c0239a613bb84baf7c7b9fd92fdb0457e1d3c9321249acc21567d7dcfd6ff0528e0e792da1b487407",
- "publisher": "asf",
- "author": "Apache Daffodil",
- "license": "Apache-2.0",
- "engines": {
- "vscode": "^1.55.0"
- },
- "icon": "images/daffodil.ico",
- "categories": [
- "Debuggers",
- "Programming Languages"
- ],
- "repository": {
- "type": "git",
- "url": "https://github.com/apache/daffodil-vscode.git"
- },
- "bugs": {
- "url": "https://github.com/apache/daffodil-vscode/issues"
- },
- "scripts": {
- "omega-edit-download": "node -e \"require('./build/scripts/omega_edit_download.ts').downloadServer()\"",
- "precompile": "node -p \"'export const LIB_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
- "compile": "tsc -p ./ && yarn omega-edit-download",
- "lint": "yarn run prettier src -c",
- "watch": "yarn omega-edit-download && webpack --watch --devtool nosources-source-map --config ./build/extension.webpack.config.js",
- "watch2": "tsc -watch -p ./",
- "webpack": "webpack --mode production --config ./build/extension.webpack.config.js",
- "prepackage": "yarn sbt && yarn install && yarn compile && yarn webpack",
- "package": "yarn package-setup && yarn package-create",
- "package-setup": "node -e \"require('./build/scripts/package.ts').setup()\"",
- "package-create": "node -e \"require('./build/scripts/package.ts').create()\"",
- "pretest": "yarn run compile",
- "test": "node node_modules/mocha/bin/_mocha -u tdd --timeout 999999 --colors ./out/tests",
- "sbt": "sbt universal:packageBin"
- },
- "dependencies": {
- "@grpc/grpc-js": "^1.5.4",
- "@types/moo": "^0.5.5",
- "await-notify": "1.0.1",
- "child_process": "1.0.2",
- "google-protobuf": "3.20.1",
- "hexy": "0.3.4",
- "moo": "0.5.1",
- "omega-edit": "0.9.20",
- "unzip-stream": "0.3.1",
- "vscode-debugadapter": "1.51.0",
- "xdg-app-paths": "7.3.0"
- },
- "devDependencies": {
- "@types/glob": "^7.1.3",
- "@types/mocha": "^9.1.1",
- "@types/node": "^18.0.0",
- "@types/vscode": "^1.55.0",
- "glob": "8.0.3",
- "mocha": "10.0.0",
- "prettier": "2.7.1",
- "ts-loader": "8.1.0",
- "typescript": "4.3.5",
- "vsce": "2.9.2",
- "vscode-debugadapter-testsupport": "1.51.0",
- "webpack": "5.73.0",
- "webpack-cli": "4.10.0"
- },
- "extensionDependencies": [
- "vincaslt.highlight-matching-tag"
- ],
- "main": "./dist/ext/extension.js",
- "activationEvents": [
- "onLanguage:dfdl",
- "onDebugResolve:dfdl",
- "onDebugDynamicConfigurations:dfdl",
- "onCommand:extension.dfdl-debug.getProgramName",
- "onCommand:extension.dfdl-debug.getDataName",
- "onCommand:extension.dfdl-debug.runEditorContents",
- "onCommand:extension.dfdl-debug.debugEditorContents",
- "onCommand:launch.config",
- "onCommand:data.edit",
- "onCommand:omega_edit.version",
- "onCommand:toggle.experimental",
- "onCommand:extension.dfdl-debug.debugLastEditorContents"
- ],
- "workspaceTrust": {
- "request": "never"
- },
- "contributes": {
- "languages": [
- {
- "id": "dfdl",
- "aliases": [
- "dfdl"
- ],
- "extensions": [
- ".dfdl.xsd"
- ],
- "configuration": "./language/dfdl.json"
- }
- ],
- "grammars": [
- {
- "language": "dfdl",
- "scopeName": "text.xml.dfdl.xsd",
- "path": "./language/syntaxes/dfdl.tmLanguage.json"
- }
- ],
- "menus": {
- "editor/title": [
- {
- "command": "launch.config",
- "group": "navigation@1"
- },
- {
- "command": "hexview.display",
- "when": "resourceLangId == dfdl",
- "group": "navigation@4"
- },
- {
- "command": "infoset.display",
- "when": "resourceLangId == dfdl",
- "group": "navigation@2"
- },
- {
- "command": "infoset.diff",
- "when": "resourceLangId == dfdl",
- "group": "navigation@3"
- }
- ],
- "editor/title/run": [
- {
- "command": "extension.dfdl-debug.runEditorContents",
- "when": "resourceLangId == dfdl"
- },
- {
- "command": "extension.dfdl-debug.debugEditorContents",
- "when": "resourceLangId == dfdl"
- },
- {
- "command": "extension.dfdl-debug.debugLastEditorContents",
- "when": "resourceLangId == dfdl"
- }
- ],
- "commandPalette": [
- {
- "command": "extension.dfdl-debug.debugEditorContents",
- "when": "resourceLangId == dfdl"
- },
- {
- "command": "extension.dfdl-debug.runEditorContents",
- "when": "resourceLangId == dfdl"
- },
- {
- "command": "data.edit",
- "enablement": "experimentalFeaturesEnabled"
- },
- {
- "command": "omega_edit.version",
- "enablement": "experimentalFeaturesEnabled"
- },
- {
- "command": "toggle.experimental"
- },
- {
- "command": "extension.dfdl-debug.debugLastEditorContents",
- "when": "resourceLangId == dfdl"
- }
- ],
- "debug/variables/context": [
- {
- "command": "extension.dfdl-debug.toggleFormatting",
- "when": "debugType == 'dfdl' && debugProtocolVariableMenuContext == 'simple'"
- }
- ]
- },
- "commands": [
- {
- "command": "extension.dfdl-debug.debugEditorContents",
- "title": "Debug File",
- "category": "Daffodil Debug",
- "enablement": "!inDebugMode",
- "icon": "$(debug-alt)"
- },
- {
- "command": "extension.dfdl-debug.runEditorContents",
- "title": "Run File",
- "category": "Daffodil Debug",
- "enablement": "!inDebugMode",
- "icon": "$(play)"
- },
- {
- "command": "extension.dfdl-debug.debugLastEditorContents",
- "title": "Debug Last File",
- "category": "Daffodil Debug",
- "enablement": "!inDebugMode",
- "icon": "$(debug-alt)"
- },
- {
- "command": "extension.dfdl-debug.toggleFormatting",
- "title": "Toggle between decimal and hex formatting",
- "category": "Daffodil Debug",
- "enablement": "inDebugMode"
- },
- {
- "command": "hexview.display",
- "title": "Display the hex view",
- "category": "Daffodil Debug",
- "enablement": "inDebugMode",
- "icon": "$(file-binary)"
- },
- {
- "command": "infoset.display",
- "title": "Display the infoset view",
- "category": "Daffodil Debug",
- "enablement": "inDebugMode",
- "icon": "$(file-code)"
- },
- {
- "command": "infoset.diff",
- "title": "View infoset diff",
- "category": "Daffodil Debug",
- "enablement": "inDebugMode",
- "icon": "$(diff)"
- },
- {
- "command": "infoset.save",
- "title": "Save the current infoset",
- "category": "Daffodil Debug",
- "enablement": "inDebugMode"
- },
- {
- "command": "launch.config",
- "title": "Configure launch.json",
- "category": "Daffodil Debug",
- "enablement": "!inDebugMode",
- "icon": "$(debug-configure)"
- },
- {
- "command": "toggle.experimental",
- "title": "Enable Experimental Features",
- "category": "Daffodil Debug"
- },
- {
- "command": "omega_edit.version",
- "title": "Omega Edit Ω Version Info",
- "category": "OmegaEdit",
- "enablement": "experimentalFeaturesEnabled"
- },
- {
- "command": "data.edit",
- "title": "Data Editor",
- "category": "OmegaEdit",
- "enablement": "experimentalFeaturesEnabled"
- },
- {
- "command": "position.goto",
- "title": "Go to position",
- "category": "OmegaEdit",
- "enablement": "experimentalFeaturesEnabled"
- }
- ],
- "keybindings": [
- {
- "command": "position.goto",
- "key": "ctrl+alt+g",
- "mac": "ctrl+cmd+g",
- "when": "editorTextFocus"
- }
- ],
- "breakpoints": [
- {
- "language": "dfdl"
- }
- ],
- "debuggers": [
- {
- "type": "dfdl",
- "languages": [
- "dfdl"
- ],
- "label": "Daffodil Debug",
- "program": "./out/extension.js",
- "runtime": "node",
- "configurationAttributes": {
- "launch": {
- "required": [
- "program",
- "data"
- ],
- "properties": {
- "program": {
- "type": "string",
- "description": "Absolute path to the DFDL schema file.",
- "default": "${command:AskForProgramName}"
- },
- "data": {
- "type": "string",
- "description": "Absolute path to the input data file.",
- "default": "${command:AskForDataName}"
- },
- "infosetOutput": {
- "type": "object",
- "description": "Destination for final Infoset (file-path | 'console' | 'none')",
- "default": {
- "type": "console",
- "path": "${workspaceFolder}/infoset.xml"
- }
- },
- "stopOnEntry": {
- "type": "boolean",
- "description": "Automatically stop after launch.",
- "default": true
- },
- "trace": {
- "type": "boolean",
- "description": "Enable logging of the Debug Adapter Protocol.",
- "default": true
- },
- "debugServer": {
- "type": "integer",
- "description": "Port debug server running on",
- "default": 4711
- },
- "useExistingServer": {
- "type": "boolean",
- "description": "Enable connection to running DAP Server",
- "default": false
- },
- "openHexView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "openInfosetView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "openInfosetDiffView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "daffodilDebugClasspath": {
- "type": "string",
- "description": "Additional classpaths to be exported to the debugger",
- "default": ""
- }
- }
- }
- },
- "initialConfigurations": [
- {
- "type": "dfdl",
- "request": "launch",
- "name": "Ask for file name",
- "program": "${command:AskForProgramName}",
- "stopOnEntry": true,
- "data": "${command:AskForDataName}",
- "infosetOutput": {
- "type": "file",
- "path": "${workspaceFolder}/infoset.xml"
- },
- "debugServer": 4711,
- "openHexView": false,
- "openInfosetView": false,
- "openInfosetDiffView": false,
- "daffodilDebugClasspath": ""
- }
- ],
- "configurationSnippets": [
- {
- "label": "Daffodil Debug: Launch",
- "description": "A new configuration for 'debugging' a user selected xml file.",
- "body": {
- "type": "dfdl",
- "request": "launch",
- "name": "Ask for file name",
- "program": "^\"\\${command:AskForProgramName}\"",
- "stopOnEntry": true,
- "data": "^\"\\${command:AskForDataName}\"",
- "infosetOutput": {
- "type": "file",
- "path": "${workspaceFolder}/infoset.xml"
- },
- "debugServer": 4711,
- "openHexView": false,
- "openInfosetView": false,
- "openInfosetDiffView": false,
- "daffodilDebugClasspath": ""
- }
- }
- ],
- "variables": {
- "AskForProgramName": "extension.dfdl-debug.getProgramName",
- "AskForDataName": "extension.dfdl-debug.getDataName"
- }
- }
- ],
- "configuration": [
- {
- "title": "Daffodil Debugger Global",
- "properties": {
- "type": {
- "type": "string",
- "default": "dfdl"
- },
- "program": {
- "type": "string",
- "description": "Absolute path to the DFDL schema file.",
- "default": "${command:AskForProgramName}"
- },
- "data": {
- "type": "string",
- "description": "Absolute path to the input data file.",
- "default": "${command:AskForDataName}"
- },
- "infosetOutputType": {
- "type": "string",
- "description": "Destination for final Infoset (file | 'console' | 'none')",
- "enum": [
- "file",
- "console",
- "none"
- ],
- "default": "none"
- },
- "infosetOutputFilePath": {
- "type": "string",
- "description": "Path to output for Infoset file (req: infosetOutput=file)",
- "default": "${workspaceFolder}/infoset.xml"
- },
- "stopOnEntry": {
- "type": "boolean",
- "description": "Automatically stop after launch.",
- "default": true
- },
- "trace": {
- "type": "boolean",
- "description": "Enable logging of the Debug Adapter Protocol.",
- "default": true
- },
- "useExistingServer": {
- "type": "boolean",
- "description": "Enable connection to running DAP Server",
- "default": false
- },
- "debugServer": {
- "type": "integer",
- "description": "Port debug server running on",
- "default": 4711
- },
- "openHexView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "openInfosetView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "openInfosetDiffView": {
- "type": "boolean",
- "description": "Open hexview on debug start",
- "default": false
- },
- "daffodilDebugClasspath": {
- "type": "string",
- "description": "Additional classpaths to be exported to the debugger",
- "default": ""
- }
- }
- }
- ]
- }
+ "name": "apache-daffodil-vscode",
Review Comment:
Is this just an indentation change? Please revert, it impossible if something actually changed. If we want to change whitespace we can do that in a separate PR.
##########
src/adapter/activateDaffodilDebug.ts:
##########
@@ -24,6 +24,35 @@ import * as launchWizard from '../launchWizard/launchWizard'
import * as omegaEditClient from '../omega_edit/client'
import * as dfdlLang from '../language/dfdl'
+// Method to file path for program and data
+async function getFile(fileRequested, label, title) {
+ let file = ''
+
+ if (fileRequested && fs.existsSync(fileRequested)) {
+ file = fileRequested
+ } else if (fileRequested && !fs.existsSync(fileRequested)) {
+ file = ''
+ } else {
Review Comment:
I dont' think I understand why we need this `fileRequested` logic? If a caller passes in `fileRequested` then we don't actually use an open dialog and get the file eslehwere? I think this needs comments explain the parameters and expected return of this function, but it's not clear based on the name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org