Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aquariuslt/karma-jawr

an karma-plugin helps generate dependencies link for jawr
https://github.com/aquariuslt/karma-jawr

jawr karma karma-plugin

Last synced: 24 days ago
JSON representation

an karma-plugin helps generate dependencies link for jawr

Host: GitHub
URL: https://github.com/aquariuslt/karma-jawr
Owner: aquariuslt
License: mit
Created: 2017-09-24T15:56:25.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2023-12-15T14:53:46.000Z (11 months ago)
Last Synced: 2024-09-17T00:58:52.353Z (about 2 months ago)
Topics: jawr, karma, karma-plugin
Language: JavaScript
Homepage:
Size: 1.38 MB
Stars: 6
Watchers: 4
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Karma JAWR

[![npm](https://img.shields.io/npm/v/karma-jawr.svg)](https://www.npmjs.com/package/karma-jawr)
[![Build Status](https://travis-ci.org/aquariuslt/karma-jawr.svg?branch=master)](https://travis-ci.org/aquariuslt/karma-jawr)
[![Circle CI Status](https://circleci.com/gh/aquariuslt/karma-jawr.svg?branch=master&style=shield)](https://github.com/aquariuslt/karma-jawr)
[![Coverage Status](https://coveralls.io/repos/github/aquariuslt/karma-jawr/badge.svg?branch=master)](https://coveralls.io/github/aquariuslt/karma-jawr?branch=master)

Karma + JAWR Integration.

### Concert & Situations

When you are using J2EE for your web application and using server-render template engine (JSP,JSF,Freemarker,Velocity), you might using some web resource bundling solution.

`JAWR` used to be a JavaEE official web resource packing solution in Java way.

But how can we setup a universal unittest way for JAWR style loading resource way?

If you are noticed `karma` is popular with managing frontend javascript side and easily integrated with reporters and CI.

Here is a karma-plugin to help you generate some `commonjs` style temp file by parsing `jawr.properties`.
So that you can use webpack or other preprocessor for writing frontend unittest in a graceful way.

### JAWR Options

- **configLocation**: Absolute path, point to `jawr.properties` or `spring-jawr-context.xml`
- **webappLocation**: Absolute path, point to your maven war project `webapp` folder
- **targetLocation**: Absolute path, point to a temp build folder, for require syntax
- **localeConfigLocation**: Absolute path, optional, if using jawr message generator and using `messages:`
syntax in jawr properties file, suppose to pre-generate by resources bundle and add as global serving files in the karma config.files.

### Usage

#### Installation

```bash
$ yarn add -D karma-jawr
```

#### Karma Configuration
1. Add `karma-jawr` as loaded plugin and framework

```
plugins:[
....,
'karma-jawr'
],
frameworks: [
...,
'jawr'
],
```

2. Add `jawr` for `karma-jawr` options
to spec the location for your `jawr.properties`, `webapp` folder for building war, template generate folder for you customize gitignore path.
using mandatory fields `configLocation`,`webappLocation`,`targetLocation`.

the value must be absolute path.
```
jawr: {
configLocation: pathUtil.resolve('src/main/resources/jawr/') + 'jawr.properties',
webappLocation: pathUtil.resolve('src/main/webapp'),
targetLocation: pathUtil.resolve('src/test/js/build')
}
```

> If you are using jawr provided locale generator for frontend locale string
> You can also add `localeConfigLocation` for locating your locale bundle resources.

#### Sample Project

You can refer to this sample project.
It using last generation J2EE way web application.

Using `SpringMVC` + `JSF` + `JAWR` + `ExtJs` for building a deployable war file.

And Integrated with travis.ci and coveralls.io for CI.

[Karma-JAWR-Sample](https://github.com/aquariuslt/karma-jawr-sample)

#### Document And Design

Please refer to [wiki](https://github.com/aquariuslt/karma-jawr/wiki)

### Change Log

#### 0.1.14
- Fix [Issue#2](https://github.com/aquariuslt/karma-jawr/issues/2) fix issue#2: mapping patterns not support /path/to/ to match non-recurring path to a directory and every resource under it will be added to the bundle

#### 0.1.13
- Update Dependencies version, and README content at npm

#### 0.1.12
- Fix defect when locale properties contains empty value while `properties` default parsed to null

#### 0.1.11
- Update .last-mappings.json path display, normalizing.

#### 0.1.10
- Update log level from info to debug.
- Fix defect when combine bundle jawr bundle names.

#### 0.1.9
- Fix when mappings in jawr properties including jawr bundle, can not generate correct index.js

#### 0.1.8
- Performance Tuning: Suppose not generate twice index files when all flatten mapping files no change since last time

#### 0.1.7
- New features: Add css bundle support, for better requiring style file for debug in browser.
- Change log level to `debug` when generating flatten mapping files for ignoring more files.
- Mini refactor JawrContext design.

#### 0.1.6
- Fix non-primitive value in locale message properties can not be parse defects.

#### 0.1.5
- Fix non-composite child key calculate not including itself defects.

#### 0.1.4

- Fix locale generator generate function key-value duplicate error.
- Fix locale message mapping detect and filter function.