Configuration

Note: A commoners.config.[ts|js] file is required for proper resolution of Plugins, which cannot be used with an inline configuration file loaded into the @commoners/solidarity API.

The commoners.config file is used to configure your application's services, plugins, and more.

This is merged with the package.json file (e.g. name, version, etc.) to resolve the final configuration of your application.

Common Configuration Options

Name

The name property defines the name of your application. This value is used as the default <title> of your application and as the Electron application name.

export default {
    name: 'My App',
}

Icon

The icon property defines the path to the icon of your application. This value is used as the default <link rel="shortcut icon"> of your application and as the Electron application icon.

export default {
    icon: './assets/vite.png',
}

Pages

The pages property defines the pages of your application. This value is a proxy for vite.build.rollupOptions.input and specifies which HTML files in your application should be built.

export default {
    pages: {
        index: './src/index.html',
        about: './src/about.html',
    },
}

Plugins

The plugins property defines the plugins of your application. This value is used to configure the plugins of your application.

export default {
    plugins: {
        'commoners-plugin': {
            load: () => {
                console.log('Plugin loaded!')
            }
        },
    },
}

More information on plugins can be found in the Plugins documentation.

Services

The services property defines the services of your application. This value is used to configure the services of your application.

export default {
    services: {
        node: './src/services/server.ts',
    },
}

More information on services can be found in the Services documentation.

Target

The target property defines the target of your application. This value is used to change the default type of application for the development and build commands.

export default {
    target: 'desktop',
}

Additional Properties

Output Directory

The outDir property defines the output directory of your application. This value is used as the immediate location for any build artifacts.

Note: Left unspecified, the application output directory is automatically defined as a target-specific subdirectory in the .commoners directory.

export default {
    outDir: 'dist',
}

The outDir property can also be specified for each build using the --outDir flag in the build command.

commoners build --outDir dist

App ID

The appId property defines the unique identifier of your application. This value is used as the default appId of your application and as the Electron application identifier.

export default {
    appId: 'com.example.myapp',
}

If not specified, the appId is generated from the name property.

Port

The port property defines the port of your application when using the start or launch command for the web target.

export default {
    target: 'desktop',
    outDir: 'dist',
    port: 3000
}

Build

The build property defines the build options of your application that aren't covered by the standard configuration.

export default {
    target: 'desktop',
    outDir: 'dist',
    build: {
        publish: true,
        sign: false
    },
}

These can also be specified for each build using the --publish and --sign flags in the build command.

commoners build --publish --no-sign

Electron

The electron property defines the Electron options of your application. This value is used to configure the Electron options of your application.

export default {
    electron: {
        nodeIntegration: true
        window: {
            width: 800,
            height: 600,
        }
    },
}

Vite

The vite property defines the Vite options of your application. This value is used to configure the Vite options of your application.

export default {
    vite: {
        server: {
            port: 3000,
        },
    },
}

This can also be specified using a vite.config.js file in the root of your project, or an alternative configuration file using the vite property.

export default {
    vite: './config.vite.js',
}