After installing 2.0, users should perform the following steps should be done to migrate their old code to new format:
Warning!!! It is not possible to revert migrated models back to old format!
- execute tools-> internal -> Add Language Design Devkit To All Languages
- execute tools-> internal -> Add General Purpose Devkit to Language Models
- execute tools-> internal -> Remove Language Design Devkit from Models
- execute tools-> internal -> Remove BootstrapLanguages Devkit from Language Models
- execute tools-> internal -> Add Necessary ModuleDeps Everywhere
- Tools-> Update Stub Refs-> Update Language Accessories Refs
- Tools-> Update Stub Refs-> Re-resolve Stub Refs
- right-click on your project -> optimize imports
- Most of the references will be fixed at the moment. But a small amount of them can be left unresolved (if threre were illegal model imports which MPS was not able to find in previous versions). So, find all broken references left and fix them manually by adding necessary module dependencies. You can use Model Checker tool to find all broken references (right-click on project -> check models)
Just execute Main Menu -> Tools -> Start Migration to MPS 2.0 and follow the instructions.
If you want full control over what MPS does, you can use this way of performing migration. In the next part we'll consider all the refactorings separately.
Do the following:
- Main Menu -> Tools -> Migrations 2.0 -> Upgrade Persistence
- Main Menu -> Tools -> Migrations 2.0 -> Fix Module Dependencies
- Main Menu -> Tools -> Migrations 2.0 -> Migrate Stub Models
- Open logical view, right-click project, select "Optimize Imports"
- Main Menu -> Tools -> Scripts -> All Scripts..., check all scripts with type "Migration (MPS 2.0)", click "Run Checked"
- Go to Main Menu -> File -> Settings. Select Model Checker properties and uncheck all checkboxes except "Check for unresolved references" and press "Ok". Right-click project node in logical view and select "Check Project". The Model Checker tool will show you all the broken references you have. Correct them by hand.
- Right-click project, select "Rebuild Project"
- (Recommended, but not necessary) Restart MPS.
What the migration will do with my code?
Upgrade Persistence: Since MPS 1.5 we've changed the format in which models are stored on disk. Commonly this is a performance-related issue. This action will re-save all models and modules in your project in a new format.
Fix Module Dependencies: In MPS 1.5 we had some unclear dependencies especially in languages and language models. This action will reconsider module imports and change their structure (some devkits will be replaced with others)
Migrate Stub Models: If you tried to use different versions of the same library in older versions of MPS, you may know that MPS didn't handle such situation. References to stub models didn't contain any information about a place from where this model is. Now it also contains the ID of the module containing a model, so that you can use different versions of the same code with the only restriction - they should not be added as stubs to the same module. So, we need to update all the references to stub models from your code. MPS does it the following way: firstly, it tries to resolve the model in scope of current module using the old "partial" id. If it succeeds, the reference is then resolved. If this fails, MPS tries to resolve it globally and if this succeeds, add a corresponding module import and resolve the reference. Also, this action will correct model imports correspondingly.
Optimize Imports: This will remove dependencies on modules that don't exist in MPS anymore (and really unused dependencies, too)
Scripts: When we change language syntax, a common way of migrating the outdated code to the new syntax (where possible) is to provide a refactoring (we call this kind of refactorings "migration scripts" not to mix them with other types of refactorings) which will change old syntax to new one (if it's possible). This action will find all MigrationScript instances in MPS and execute those of them which have a "migration" type (there are also so-called "enhancement scripts", which will not be executed by this action).
Model Checker and manual references resolution: If you have used some internal API, or somewhy MPS couldn't resolve a stub reference or any other reference, you can correct them manually. This tool will help to find all such references.
Rebuild: After you have migrated your code (MPS models) to match 2.0 version, they should be rebuilt and recompiled to start working in MPS. That's what this step does.
There was one change in MPS 2.0 for which we can't provide a common migration, so if you have used this feature, you are to correct your code by hand. But we suppose that nobody has actually used this feature till the moment.
So, the problem appears if you had created your own "attributes" (instances of
AnnotationLinkDeclaration) with complex hierarchies (in case when your attributes are direct subconcepts of
BaseConcept, the migration script will do everything for you, both in automatic and non-automatic scenario).
Migration for such hierarchical attributes is the following:
- Ensure attribute concept described in
target) is subconcept of one of
PropertyAttributedepending on the attribute
roleconcept property in attribute concept as attribute
sourceCardinalitywas * define
multipleconcept property in attribute concept
attributedconcept link from
- Perform actions from steps 1 and 2 for migrated attributes
- For simple attributes (when they are direct subconcepts of
BaseConcept) migration script is available
- To make virtual packages (folders) visible again
- Tools -> Scripts -> By Language -> jetbrains.mps.lang.core -> Restore Virtual Packages
- To convert TabbedEditors and icons in plugin aspects
- Tools-> Scripts-> By Language -> jetbrains.mps.lang.plugin -> split tabbed editors
- Tools-> Scripts-> By Language -> jetbrains.mps.lang.plugin -> Update Icons
- To migrate to the new trace information generation
- Tools -> Scripts->By Language->jetbrains.mps.lang.plugin->Upgrade Trace Info Generation
- Execute Tools->Scripts->By Language-> jetbrains.mps.baseLanguage.closures-> remove wildcards from unbound params
- Execute Tools->Scripts->By Language-> jetbrains.mps.baseLanguage.runConfigurations -> Fix References To Deleted Run Models
- Regenerate (!!! use "Rebuild" action, not "Make")
- all project languages
- all project solutions (!!! after languages)
Migration to 2.0.1
1) To fix module dependencies, execute "Add missing imports" action on project