feat: Validations and zip scripts added #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| const archive = archiver('zip', { zlib: { level: COMPRESSION_LEVEL } }); | ||
|
|
||
| output.on('close', function () { | ||
| console.log(`Successfully zipped out folder to out.zip`); |
There was a problem hiding this comment.
Successfully created [name].zip
| import { readFileSync } from 'fs'; | ||
| import { resolve } from 'path'; | ||
|
|
||
| const errors = []; |
There was a problem hiding this comment.
should not be a global variable.
| const requiredFields = ['id', 'title', 'url', 'scopes']; | ||
| const optionalFields = ['props']; | ||
|
|
||
| checkRedundantFields(config, requiredFields, optionalFields); |
| const optionalFields = ['props']; | ||
|
|
||
| checkRedundantFields(config, requiredFields, optionalFields); | ||
| validateRequiredFields(config, requiredFields, true); |
| function validateRequiredFields({ config, requiredFields, isWidget }) { | ||
| const errors = []; | ||
|
|
||
| requiredFields.forEach(field => { |
| const path = resolve(process.cwd(), 'manifest.json'); | ||
| const config = JSON.parse(readFileSync(path)); | ||
|
|
||
| try { |
tools/validate.js
Outdated
| }; | ||
|
|
||
| const validateProps = props => { | ||
| const errors = [`Value of field props should be an object`]; |
There was a problem hiding this comment.
Field props of ___ should be an object
tools/validate.js
Outdated
| Object.entries(config).reduce((acc, [key]) => { | ||
| if (!requiredFields.includes(key) && !optionalFields.includes(key)) { | ||
| acc.push( | ||
| `Field '${key}' should be removed from ${ |
There was a problem hiding this comment.
should be removed from <> not supported
tools/validate.js
Outdated
| if (!requiredFields.includes(key) && !optionalFields.includes(key)) { | ||
| acc.push( | ||
| `Field '${key}' should be removed from ${ | ||
| isWidget !== undefined ? `${isWidget ? 'widget' : 'page'} "${config.title}"` : 'manifest object' |
There was a problem hiding this comment.
too complicated. move to a function. return full strings
tools/validate.js
Outdated
| if (!(field in config)) { | ||
| acc.push(`Field '${field}' is required in manifest object`); | ||
| } else if (field === 'integrationType' && !INTEGRATION_TYPES.includes(config[field])) { | ||
| acc.push(`Field ${field} should be one of ${INTEGRATION_TYPES}`); |
There was a problem hiding this comment.
we already know if its a react type widget of iframe. user doesnt need to choose. it should be according to the widget type
abhi12706
changed the title
Anuj-Mittal
reviewed
Dec 8, 2023
scripts/zip.js
Outdated
| const path = resolve(process.cwd(), 'manifest.json'); | ||
| const config = JSON.parse(readFileSync(path)); | ||
|
|
||
| const zipFileName = config.name + ' ' + config.version + '.zip'; |
Anuj-Mittal
reviewed
Dec 8, 2023
scripts/validate.js
Outdated
|
|
||
| const appType = '<%=appType%>'; | ||
|
|
||
| const INTEGRATION_TYPES = { 'React Component': 'VIRTUALIZED', iFrame: 'CONTAINERIZED' }; |
There was a problem hiding this comment.
can we put all these keys, values in constants and use that everywhere?
There was a problem hiding this comment.
should we rename this to something like APP_TYPE_VS_INT_TYPE?
Anuj-Mittal
reviewed
Dec 8, 2023
scripts/validate.js
Outdated
| }; | ||
|
|
||
| const checkRedundantFields = ({ config, requiredFields, optionalFields, isWidget }) => | ||
| Object.entries(config).reduce((acc, [key]) => { |
Anuj-Mittal
reviewed
Dec 8, 2023
scripts/validate.js
Outdated
| return acc; | ||
| }, []); | ||
|
|
||
| const validateManifestOptionalFields = (config, optionalFields) => |
There was a problem hiding this comment.
can we reduce over config and remove optionalFields arg?
Anuj-Mittal
reviewed
Dec 8, 2023
scripts/validate.js
Outdated
| const validateManifestOptionalFields = (config, optionalFields) => | ||
| optionalFields.reduce((acc, field) => { | ||
| if (field === 'basePath') { | ||
| if (field in config && !(typeof config[field] === 'string' && isUrlValid(config[field]))) { |
There was a problem hiding this comment.
also we can use exhaustive switch statement here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.