feat(codegen): code generator to bootstrap vocab file (#21)

[sanketshevkar]

Closes #21

Changes

• new code generator added to generate vocab YAML file

Flags

• Tests cases for field types like enumValues, relationships and fields is remaining.

Screenshots or Video

Related Issues

• Issue #
• Pull Request #

Author Checklist

• Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
• Vital features and changes captured in unit and/or integration tests
• Commits messages follow AP format
• Extend the documentation, if necessary
• Merging to main from fork:branchname

[dselman]

Looks great. Thanks! 🙏

[mttrbrts]

The npm run build:types command is failing in the build. Can you look into it, please?

[sanketshevkar]

The npm run build:types command is failing in the build. Can you look into it, please?

@mttrbrts I investigated the error. Looks like the error is from concerto-vocabulary package. The following types shown in the error were not imported.
I tried to hard code a fix, some thing like this

export = Vocabulary;

// fix starts
import {VocabularyManager} from "../index";
import {ModelFile} from "@accordproject/concerto-core/types/index";
//fix ends

/**
* A vocabulary for a concerto model
* @class
* @memberof module:concerto-vocabulary
*/
declare class Vocabulary {
    /**
     * Create the Vocabulary
     * @constructor
     * @param {VocabularyManager} vocabularyManager - the manager for this vocabulary
     * @param {object} voc - the JSON representation of the vocabulary
     */
    constructor(vocabularyManager: VocabularyManager, voc: object);
    vocabularyManager: VocabularyManager;
    content: any;
    /**
     * Returns the namespace for the vocabulary
     * @returns {string} the namespace for this vocabulary
     */
    getNamespace(): string;
    /**
     * Returns the locale for the vocabulary
     * @returns {string} the locale for this vocabulary
     */
    getLocale(): string;
    /**
     * Returns the identifier for the vocabulary, composed of the namespace plus the locale
     * @returns {string} the identifier for this vocabulary
     */
    getIdentifier(): string;
    /**
     * Returns all the declarations for this vocabulary
     * @returns {Array} an array of objects
     */
    getTerms(): any[];
    /**
     * Gets the term for a concept, enum or property
     * @param {string} declarationName the name of a concept or enum
     * @param {string} [propertyName] the name of a property (optional)
     * @returns {string} the term or null if it does not exist
     */
    getTerm(declarationName: string, propertyName?: string): string;
    /**
     * Validates a vocabulary against a ModelFile, returning errors for
     * missing and additional terms.
     * @param {ModelFile} modelFile the model file for this vocabulary
     * @returns {*} an object with missingTerms and additionalTerms properties
     */
    validate(modelFile: ModelFile): any;
    /**
     * Converts the object to JSON
     * @returns {*} the contens of this vocabulary
     */
    toJSON(): any;
}

It works. But I think these types should be auto-imported. I believe these type declarations are auto-generated using the JSDOC comments? @dselman

[mttrbrts]

@mttrbrts I investigated the error. Looks like the error is from concerto-vocabulary package. The following types shown in the error were not imported.

It works. But I think these types should be auto-imported. I believe these type declarations are auto-generated using the JSDOC comments? @dselman

Well spotted @sanketshevkar, I put in a fix here, accordproject/concerto#657

Once that is merged you can update your dependency on the concerto-vocabulary package here, and the build should work. (I tested that locally already).

[sanketshevkar]

Okay got it. Thanks for the fix @mttrbrts 👍

[mttrbrts]

Try locally with the unstable package @accordproject/concerto-vocabulary@3.8.2-20230607124239, if it works for you, I'll make a stable release

[sanketshevkar]

Try locally with the unstable package @accordproject/concerto-vocabulary@3.8.2-20230607124239, if it works for you, I'll make a stable release

@mttrbrts it's working locally. 🙌

[mttrbrts]

@mttrbrts it's working locally. 🙌

👍I've published 3.8.2 this evening.

[sanketshevkar]

I've made the changes and pushed the code. Locally I've encountered a merge conflict with a snapshot file. I'll fix that and update you.

[coveralls]

coverage: 98.942% (+0.04%) from 98.906% when pulling eee5036 on sanketshevkar:sanketshevkar/i21/create-bootstrap-eng-vocab-file into ba60afd on accordproject:main.

[sanketshevkar]

Not sure why, this branch shows no conflict with main, but I'm trying to rebase with main on my local, it's showing merge conflicts.

[mttrbrts]

Not sure why, this branch shows no conflict with main, but I'm trying to rebase with main on my local, it's showing merge conflicts.

Likely your main branch has diverged. GitHub is happy, so we can merge.

I recommend deleting your local copy of main and checkout again. Otherwise, you can do a hard reset to the upstream branch.

[sanketshevkar]

Yep makes sense. Thanks for merging @mttrbrts. I think I should update the documentation next.

[sanketshevkar]

Documentation for vocabulary code generation
accordproject/concerto-docs#16