karma-runner / shared-karma-files

Shared configs for all the Karma repos.

karma-shared-files

karma-shared-files centralizes all the shared files between the Karma projects.

Installation

npm install karma-shared-files --save-dev

Usage

Shared folder

The files in the shared folder are meant to be directly linked inside your project without any modification. For more information, see the karmaSharedFiles option.

Models folder

The files in the models folder are meant to be copied and modified to fit your needs.

Options

sharedKarmaFiles

Type: Object

You have to provide an object which will be used to determined which files have to be linked and where they should be linked.

The keys represent which files you want to link (relatively to the ./shared folder in this very repository), the values represent where you want to link them (relatively to your package.json).

Examples

This example shows how to link the editorconfig from the shared folder to the .editorconfig endpoint at your project root.

sharedKarmaFiles: {
  "editorconfig": ".editorconfig"
}

This example shows how to link the integration-tests.sh file to a specific folder.

sharedKarmaFiles: {
  "test/integration-tests.sh": "test/integration-tests.sh"
}

Notes

• This repository is intended to be used by Karma developers.
• Tools documentation:
  • CoffeeLint
  • EditorConfig
  • JSCS
  • JSHint

Contributors

See package.json.

License

See LICENSE.

shared-karma-files's Issues

Package name conflict

We need to change the name key in package.json as it may be a day in conflict with this package.

This will not impact the repository name on GitHub.

@vojtajina didn't want to use karma-common as karma-xxx has to be kept for Karma plugins.

So here some suggestions:

• common-files-karma
• common-karma

What do you think guys?

JavaScript space between parenthesis

Hello,

We have an example here of a code which passes the JSCS check with and without space between the parenthesis.

if (true) and if ( true ) are both correct by now.

I suggest we add a new rule to forbid the second case.

Thoughts on it?

Register package on npmjs.org

npm install karma-shared-files --save-dev
npm http GET https://registry.npmjs.org/karma-shared-files
npm http 404 https://registry.npmjs.org/karma-shared-files
npm ERR! 404 404 Not Found: karma-shared-files
npm ERR! 404 
npm ERR! 404 'karma-shared-files' is not in the npm registry.

Reflection

So here are centralized all the configuration files for the karma projects. We need to make some of them (CoffeeLint, JSCS, JSHint, Git attributes) accessible from the project root directory.

I think the most pertinent way is to create symlinks via a postinstall script. The only issue I see is to get the absolute path of the project root from the postinstall script.

Any though on it?