Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat/SOF-7249: JS -> TS conversion #117

Open
wants to merge 17 commits into
base: epic/SOF-6048
Choose a base branch
from
Open

Conversation

seankwarren
Copy link
Contributor

@seankwarren seankwarren commented Feb 12, 2024

Changes to asset generation:

Previously assets were generated by build_filter_trees.js and build_templates.js in the root directory. Due to the dual repo (js/python) nature of the repo, these have been moved inside the src/js folder. build_templates.js has been renamed to build_application_trees.ts to better match its responsibility. Additionally, the asset generation has been updated to run directly on the new ts generation scripts via ts-node (see package.json scripts). The generated assets are now generated as const in typescript and included in transpilation, resulting in declaration files for these object assets.
Example:
old:

module.exports = { key: ... };

new:

export const key = {...} as const;
export default key;

How to update:

Package Exports Added

  • allowedApplications, and allowedPostProcessors as new package exports
  • types for AllowedApplications, AllowedResults, AllowedMonitors, AllowedPostProcesors

Package Exports Renamed

  • applicationTree->applicationExecutableFlavorTree: the nested application, executable, flavor heirarchy
  • getAppTree->getApplicationExecutableFlavorData: get an application from applicationExecutableFlavorTree
  • applicationData->applicationVersionBuildTree: the nested application, version, build heirarchy
  • getAppData->getApplicationVersionBuildData: get an application from applicationVersionBuildTree
  • getAllAppTemplates->loadApplicationTemplates: loads the template yml assets and returns as json
  • getAllAppData->loadApplicationVersionBuildTree: loads the application yml assets and returns as json
  • getAllAppTree->loadApplicationExecutableFlavorTree: loads the executable yml assets and returns as json

Update PRs:

Update test results: https://ci.mat3ra.com/job/Stack-SOF-20230525/1224/console

@seankwarren seankwarren changed the title JS -> TS conversion feat/SOF-7249: JS -> TS conversion Feb 28, 2024
@seankwarren seankwarren changed the base branch from main to epic/SOF-6048 February 28, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants