stevedlawrence commented on code in PR #232: URL: https://github.com/apache/daffodil-vscode/pull/232#discussion_r924478077
########## build/scripts/package.ts: ########## @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// @ts-nocheck <-- This is needed as this file is basically a JavaScript script +// but with some TypeScript niceness baked in +const fs = require('fs') +const path = require('path') +const glob = require('glob') +const execSync = require('child_process').execSync +const pkg_dir = 'dist/package' + +async function copyGlob(pattern) { + glob(pattern, (error, files) => { + for (var i = 0; i < files.length; i++) { + // Skip dirs as they are most likely listed in the .vscodeignore as well + if (fs.statSync(files[i]).isDirectory()) continue + + let src = files[i] + let dst = path.join(pkg_dir, src.replace('build/package', '')) Review Comment: I'd prefer we don't hardcode `build/package` in this function. I imagine we might want to use this for something else in the future. Did the cwd approach mentioned in another comment not work? ########## README.md: ########## @@ -39,14 +39,14 @@ This is a VS Code extension which enables the interactive debugging of DFDL sche Until the extension is available in the [VS Code Extension Marketplace](https://marketplace.visualstudio.com/vscode), please download the latest `.vsix` file from the [releases page](https://github.com/apache/daffodil-vscode/releases). -## Build VSIX and Debugger +## Package VSIX and Debugger :exclamation:**NOT necessary if using prebuilt VSIX**:exclamation: :exclamation:**NOT necessary if running extension via VS Code without VSIX but a `yarn install` will be required**:exclamation: -Run full build +Run full package ```bash - yarn build + yarn package Review Comment: I think `yarn package` is an improvement, but we'll also need to update `containers/release-candidate/src/daffodil-release-candidate` in the daffodil repo to use yarn package as well. ########## build/scripts/package.ts: ########## @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// @ts-nocheck <-- This is needed as this file is basically a JavaScript script +// but with some TypeScript niceness baked in +const fs = require('fs') +const path = require('path') +const glob = require('glob') +const execSync = require('child_process').execSync +const pkg_dir = 'dist/package' + +async function copyGlob(pattern) { + glob(pattern, (error, files) => { + for (var i = 0; i < files.length; i++) { + // Skip dirs as they are most likely listed in the .vscodeignore as well + if (fs.statSync(files[i]).isDirectory()) continue + + let src = files[i] + let dst = path.join(pkg_dir, src.replace('build/package', '')) + let dstDir = path.dirname(dst) + + if (!fs.existsSync(dstDir)) { + fs.mkdirSync(dstDir, { recursive: true }) + } + + fs.copyFileSync(src, dst) + } + }) +} + +// Setup package directory +function setup() { + if (fs.existsSync(pkg_dir)) { + fs.rmdirSync(pkg_dir, { recursive: true }) + } + + fs.mkdirSync(pkg_dir) + + let lines = fs + .readFileSync('build/package/.vscodeignore') + .toString() + .split('\n') + + // Copy all files listed in the .vscodeignore + for (var i = 0; i < lines.length; i++) { + var line = lines[i] + + if (!line.startsWith('!')) continue + + let pattern = line.substring(1).trim() + + copyGlob(pattern) + } + + // Copy required package files into package directory + copyGlob('build/package/{.,}*') // include hidden files + + fs.copyFileSync('yarn.lock', `${pkg_dir}/yarn.lock`) +} + +// Create VSIX package +function create() { + execSync('yarn install', { cwd: pkg_dir }) + execSync('yarn vsce package --out ../../', { cwd: pkg_dir }) +} + +module.exports = { + setup: setup, + create: create, Review Comment: Just out of curiosity, previously you had the exec stuff done after files were copied and now you have it split into separate functions. This is fine with me, but I'm trying to get a better grasp of how yarn works--is there a special reason this is needed, or just thought it would be good to split things up? ########## build/scripts/package.ts: ########## @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// @ts-nocheck <-- This is needed as this file is basically a JavaScript script +// but with some TypeScript niceness baked in +const fs = require('fs') +const path = require('path') +const glob = require('glob') +const execSync = require('child_process').execSync +const pkg_dir = 'dist/package' + +async function copyGlob(pattern) { + glob(pattern, (error, files) => { + for (var i = 0; i < files.length; i++) { + // Skip dirs as they are most likely listed in the .vscodeignore as well + if (fs.statSync(files[i]).isDirectory()) continue Review Comment: Why skip directories that match the glob? If a glob matches a directory in .vscodeignore don't we want them too? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
