Skip to content
This repository has been archived by the owner on May 19, 2020. It is now read-only.

Commit

Permalink
refactor: add missing ng prefix to the angular module name
Browse files Browse the repository at this point in the history
replace module name from 'ovh-angular-otrs' to 'ngOvhOtrs'

BREAKING CHANGE: module is now named as `ngOvhOtrs`
  • Loading branch information
antleblanc committed Jan 18, 2019
1 parent e13fef2 commit 8b74854
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 189 deletions.
6 changes: 1 addition & 5 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
{
"root": true,
"extends": "airbnb-base",
"parser": "babel-eslint",
"plugins": [
"angular",
"markdown"
],
"env": {
"browser": true,
"jquery": true
"browser": true
},
"rules": {
"import/no-unresolved": 0
Expand Down
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Contributing to ovh-angular-otrs
# Contributing to ng-ovh-otrs

This project accepts contributions. In order to contribute, you should
pay attention to a few things:

1. your code must follow the coding style rules
2. your code must be unit-tested
3. your code must be documented
4. your work must be signed (see below)
5. you may contribute through GitHub Pull Requests

# Coding and documentation Style

Refer to [https://github.com/ovh-ux/eslint-config-ovh](https://github.com/ovh-ux/eslint-config-ovh)

# Submitting Modifications

The contributions should be submitted through Github Pull Requests.

# Licensing for new files
ovh-angular-otrs is licensed under a BSD-3-Clause license. Anything
contributed to ovh-angular-otrs must be released under this license.

ng-ovh-otrs is licensed under a BSD-3-Clause license. Anything
contributed to ng-ovh-otrs must be released under this license.

When introducing a new file into the project, please make sure it has a
copyright header making clear under which license it's being released.
55 changes: 14 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,23 @@
# Manage OTRS tickets
# ng-ovh-otrs

![githubbanner](https://user-images.githubusercontent.com/3379410/27423240-3f944bc4-5731-11e7-87bb-3ff603aff8a7.png)
> Manage OVH OTRS tickets
[![Maintenance](https://img.shields.io/maintenance/yes/2018.svg)](https://github.com/ovh-ux/ovh-angular-otrs/blob/master) [![Chat on gitter](https://img.shields.io/gitter/room/ovh/ux.svg)](https://gitter.im/ovh/ux) [![Build Status](https://travis-ci.org/ovh-ux/ovh-angular-otrs.svg)](https://travis-ci.org/ovh-ux/ovh-angular-otrs)
[![Downloads](https://badgen.net/npm/dt/@ovh-ux/ng-ovh-otrs)](https://npmjs.com/package/@ovh-ux/ng-ovh-otrs) [![Dependencies](https://badgen.net/david/dep/ovh-ux/ng-ovh-otrs)](https://npmjs.com/package/@ovh-ux/ng-ovh-otrs?activeTab=dependencies) [![Dev Dependencies](https://badgen.net/david/dev/ovh-ux/ng-ovh-otrs)](https://npmjs.com/package/@ovh-ux/ng-ovh-otrs?activeTab=dependencies) [![Gitter](https://badgen.net/badge/gitter/ovh-ux/blue?icon=gitter)](https://gitter.im/ovh/ux)

[![NPM](https://nodei.co/npm/ovh-angular-otrs.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ovh-angular-otrs/)

# Installation

## Bower
# Install

```sh
bower install ovh-angular-otrs --save
yarn add @ovh-ux/ng-ovh-otrs
```

## NPM

```sh
npm install ovh-angular-otrs --save
```

# Howto's

Inject module
## Usage

```js
import angular from 'angular';
import '@ovh-ux/ng-ovh-otrs';

angular
.module('myApp', ['ovh-angular-otrs'])
.module('myApp', ['ngOvhOtrs'])
.config(/* @ngInject */ (OtrsPopupProvider) => {
// Inject it to manager-navbar at app.config:
OtrsPopupProvider.setBaseUrlTickets('');
Expand All @@ -52,32 +41,16 @@ const assistanceMenu = [{
}];
```

## Get the sources

```sh
git clone https://github.com/ovh-ux/ovh-angular-otrs.git
cd ovh-angular-otrs
npm install
bower install
```

You've developed a new cool feature? Fixed an annoying bug? We'd be happy
to hear from you!

Have a look in [CONTRIBUTING.md](https://github.com/ovh-ux/ovh-angular-otrs/blob/master/CONTRIBUTING.md)

## Run the tests
## Test

```sh
npm test
yarn test
```

# Related links
## Contributing

* Contribute: https://github.com/ovh-ux/ovh-angular-otrs/blob/master/CONTRIBUTING.md
* Report bugs: https://github.com/ovh-ux/ovh-angular-otrs/issues
* Get latest version: https://github.com/ovh-ux/ovh-angular-otrs
Always feel free to help out! Whether it's [filing bugs and feature requests](https://github.com/ovh-ux/ng-ovh-otrs/issues/new) or working on some of the [open issues](https://github.com/ovh-ux/ng-ovh-otrs/issues), our [contributing guide](CONTRIBUTING.md) will help get you started.

# License
## License

See https://github.com/ovh/ovh-angular-otrs/blob/master/LICENSE.md
[BSD-3-Clause](LICENSE) © OVH SAS
8 changes: 3 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "ovh-angular-otrs",
"name": "@ovh-ux/ng-ovh-otrs",
"version": "7.0.0-alpha.1",
"description": "Manage OTRS tickets",
"repository": "ovh-ux/ovh-angular-otrs",
"repository": "ovh-ux/ng-ovh-otrs",
"license": "BSD-3-Clause",
"author": "OVH SAS",
"files": [
"dist"
],
"main": "./dist/cjs/index.js",
"browser": "./dist/umd/ovh-angular-otrs.js",
"browser": "./dist/umd/ng-ovh-otrs.js",
"scripts": {
"build": "rollup -c",
"lint": "run-p lint:css lint:js lint:md",
Expand All @@ -28,12 +28,10 @@
"@commitlint/cli": "^7.1.2",
"@commitlint/config-angular": "^7.1.2",
"@ovh-ux/component-rollup-config": "^5.0.0-beta.4",
"babel-eslint": "^8.2.6",
"bootstrap": "^3.3.6",
"eslint": "^5.9.0",
"eslint-config-airbnb-base": "^13.1.0",
"eslint-formatter-pretty": "^2.0.0",
"eslint-plugin-angular": "^3.3.0",
"eslint-plugin-import": "^2.14.0",
"eslint-plugin-markdown": "^1.0.0",
"htmlhint": "^0.10.1",
Expand Down
11 changes: 7 additions & 4 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ import OtrsPopupInterventionService from './otrs-popup/intervention/otrs-popup-i

import './otrs.less';

export default angular
.module('ovh-angular-otrs', [
const moduleName = 'ngOvhOtrs';

angular
.module(moduleName, [
'ovh-api-services',
'ovh-jquery-ui-draggable-ng',
'pascalprecht.translate',
Expand All @@ -39,5 +41,6 @@ export default angular
.directive('otrsPopup', OtrsPopupDirective)
.provider('OtrsPopup', OtrsPopupProvider)
.service('OtrsPopupService', OtrsPopupService)
.service('OtrsPopupInterventionService', OtrsPopupInterventionService)
.name;
.service('OtrsPopupInterventionService', OtrsPopupInterventionService);

export default moduleName;
Loading

0 comments on commit 8b74854

Please sign in to comment.