comunica / generate-comunica

🎛 Generators for comunica packages

Comunica Generator

This is a collection of Comunica package generators that can be used for creating new Comunica packages.

Learn more about modifying Comunica.

Usage

Installation

Comunica requires Node.JS 14.0 or higher and is tested on OSX and Linux.

1. Make sure yo is globally installed: npm install -g yo
2. Clone this repository: git clone [email protected]:comunica/generate-comunica.git
3. Run npm install in the cloned directory.
4. Run npm link in this directory for installing this generator.

Generating a new actor

Running yo comunica:actor or yo comunica:actor --name my-name --bus bus-name will create a new actor package.

Running yo comunica:actor-query-operation or yo comunica:actor-query-operation operation-name will create a new query operation actor package.

Generating a new bus

Running yo comunica:bus or yo comunica:bus --name my-name will create a new bus package.

Generating a new mediator

Running yo comunica:mediator or yo comunica:mediator --name my-name will create a new mediator package.

License

This code is copyrighted by the Comunica Association and Ghent University – imec and released under the MIT license.

generate-comunica's Issues

Update to comunica v2 conventions

For Bus's the template file should look something like:

import { Actor, IAction, IActorArgs, IActorOutput, IActorTest, Mediate } from '@comunica/core';

/**
 * <%= descriptionActor %>
 *
 * Actor types:
 * * Input:  IAction<%= componentBaseName %>:      TODO: fill in.
 * * Test:   <none>
 * * Output: IActor<%= componentBaseName %>Output: TODO: fill in.
 *
 * @see IAction<%= componentBaseName %>
 * @see IActor<%= componentBaseName %>Output
 */
export abstract class Actor<%= componentBaseName %> extends Actor<IAction<%= componentBaseName %>, IActorTest, IActor<%= componentBaseName %>Output> {
  public constructor(args: IActor<%= componentBaseName %>Args) {
    super(args);
  }
}

export interface IAction<%= componentBaseName %> extends IAction {

}

export interface IActor<%= componentBaseName %>Output extends IActorOutput {

}

export type IActor<%= componentBaseName %>Args = IActorArgs<IAction<%= componentBaseName %>, IActorTest, IActor<%= componentBaseName %>Output>

export type Mediator<%= componentBaseName %> = Mediate<IAction<%= componentBaseName %>, IActor<%= componentBaseName %>Output>

Happy to create a PR with this - if so, are there any other changes I should integrate at the same time?

Generators in a comunica standalone project

According to the documentation, the yeoman generators can be used in a standalone project like in the monorepo (assuming that needed dependencies are installed).

I have "@comunica/core": "^1.0.0" as dev dependency installed, but yo comunica:actor throws the error

events.js:167
      throw er; // Unhandled 'error' event
      ^

Error: Cannot find module '/home/slieber/repos/comunica-shapes-processor/./packages/core/package.json'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:581:15)
    at Function.Module._load (internal/modules/cjs/loader.js:507:25)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:20:18)
    at module.exports.writing (/home/slieber/repos/generate-comunica/generators/actor/index.js:119:41)
    at Object.<anonymous> (/home/slieber/repos/generate-comunica/node_modules/yeoman-generator/lib/index.js:399:25)
    at /home/slieber/repos/generate-comunica/node_modules/run-async/index.js:25:25
    at new Promise (<anonymous>)
    at /home/slieber/repos/generate-comunica/node_modules/run-async/index.js:24:19
    at self.env.runLoop.add.completed (/home/slieber/repos/generate-comunica/node_modules/yeoman-generator/lib/index.js:400:11)
Emitted 'error' event at:
    at Immediate.setImmediate (/home/slieber/repos/generate-comunica/node_modules/yeoman-generator/lib/index.js:406:18)
    at runCallback (timers.js:693:18)
    at tryOnImmediate (timers.js:664:5)
    at processImmediate (timers.js:646:5)

Instead of looking into ./node_modules/@comunica/core directory, the generator assumes the comunica core to be present in the current directory.

The dependencies on comunica still use `^0.0.1`

Current release is 1.0.0, so it's incompatible.

Fix: Generate correct version

I suggest that the package.json's and be generated with a version number matching that of @comunica/core rather than v1.0.0

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Feat: Generate query-sparql actors

It would be nice to have a generator for query-sparql-x actors