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

issue/2662 Formalised plugin, data, schema and translate API #2667

Merged
merged 10 commits into from
Mar 12, 2020

Conversation

oliverfoster
Copy link
Member

@oliverfoster oliverfoster commented Feb 28, 2020

fixes #2662

Additions

Changes

  • Changed grunt/config/build-config and grunt/config/replace to use the new API
  • Updated grunt/helpers to use new API, fixed some linting and escaping issues, changed the module.export to work with intellisense and treated core as a plugin in the includes regular expression
  • Fixed linting and escaping issues in grunt/tasks/handlebars (so that the grunt folder passes linting)
  • Changed grunt/tasks/schema-defaults, grunt/tasks/tracking-insert, grunt/tasks/tracking-remove, grunt/tasks/tracking-reset and grunt/tasks/translate to use the new API, simplifying them greatly

Removed

  • Deleted grunt/config/tracking-insert, grunt/config/tracking-remove, grunt/config/tracking-reset and grunt/config/translate configs as they are no longer needed
  • Deleted previous translate code as it is now encapsulated in the new API

Notes

The build tasks should carry on working as normal, this change should be non-breaking but should increase code clarity dramatically. It is necessary to formalise these in order to the move to v6.
Intellisense should work really nicely for the new API in at least VSCode.
If you want to debug grunt you can use grunt-brk and chrome://inspect.

@oliverfoster oliverfoster mentioned this pull request Feb 28, 2020
Copy link
Contributor

@tomgreenfield tomgreenfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting the ⚾️ rolling.

grunt/helpers/Data.js Outdated Show resolved Hide resolved
grunt/helpers/Data.js Outdated Show resolved Hide resolved
grunt/helpers/Data.js Outdated Show resolved Hide resolved
grunt/helpers/Data.js Outdated Show resolved Hide resolved
grunt/helpers/Data.js Outdated Show resolved Hide resolved
grunt/helpers/data/Language.js Outdated Show resolved Hide resolved
grunt/helpers/lib/JSONFile.js Outdated Show resolved Hide resolved
grunt/helpers/lib/JSONFile.js Outdated Show resolved Hide resolved
grunt/helpers/plugins/Plugin.js Outdated Show resolved Hide resolved
grunt/helpers/Schemas.js Show resolved Hide resolved
@oliverfoster
Copy link
Member Author

Awaiting a framework release and a few more reviews before merging.

@oliverfoster
Copy link
Member Author

oliverfoster commented Mar 11, 2020

This pr is ready for final +1s if anyone has the inclination.

removeTrackingIds(blocksFiles[i], courseFiles[i]);
}

const data = Helpers.getFramework().getData();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's not part of your changes but I think the check for spoor in L4 should be removed.

Copy link
Member Author

@oliverfoster oliverfoster Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will have a crack at this when I layout moving tracking ids from blocks to components.
I wanted to keep the behaviour here as close to identical with additions only for the moment.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

@oliverfoster oliverfoster merged commit 674fee2 into master Mar 12, 2020
@oliverfoster oliverfoster deleted the issue/2662 branch March 12, 2020 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Formalise Adapt framework, plugin, data and schema API
7 participants