open-index/open-npm huggingface dataset:
npm package: @sharegainltd/ng-idle-core
Description: A module for detecting and responding to the user becoming idle in Angular applications.
Author: Mike Grabski
Latest version: 9.0.0

# Core

This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.0.0.

## Code scaffolding

Run `ng generate component component-name --project core` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project core`.
> Note: Don't forget to add `--project core` or else it will be added to the default project in your `angular.json` file. 

## Build

Run `ng build core` to build the project. The build artifacts will be stored in the `dist/` directory.

## Publishing

After building your library with `ng build core`, go to the dist folder `cd dist/core` and run `npm publish`.

## Running unit tests

Run `ng test core` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
npm package: @sharegate/browserslist-config
Description: Sharegate recommended Browserslist config.
Author: Groupe ShareGate inc.
Latest version: 1.0.1

# `@sharegate/browserslist-config`

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE.md) 
[![npm version](https://img.shields.io/npm/v/@sharegate/browserslist-config)](https://www.npmjs.com/package/@sharegate/browserslist-config)


Shareable [browserslist](https://github.com/browserslist/browserslist) configuration for ShareGate.

## Installation

Install the package.

**With npm**
```shell
npm i --save-dev @sharegate/browserslist-config
```

**With yarn**
```shell
yarn add --dev @sharegate/browserslist-config
```

## Supported Browsers

You can list all supported browsers by following this link:
https://browsersl.ist/#q=last+1+year%2C+%3E+0.2%25%2C+Firefox+ESR%2C+not+dead%2C+not+op_mini+all

## Usage

Create a `.browserslistrc` file at the root of your project with the following content:
```
extends @sharegate/browserslist-config
```

## License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/browserslist-config-recommended
Description: Sharegate recommended Browserslist config.
Author: Groupe Sharegate inc.
Latest version: 3.0.0
Deprecated: Package no longer supported. Use @sharegate/browserslist-config instead.

# ShareGate Browserslist config

Sharegate shared [Browserslist](https://github.com/browserslist/browserslist) config.

## Installation

Install the package.

With NPM:

```bash
npm i -D @sharegate/browserslist-config-recommended
```

Create a `.browserslistrc` file at the root of your project.

Add the following configuration:

```
extends @sharegate/browserslist-config-recommended
```

## Maintainers

The following documentation is only for the maintainers of this repository.

### Installation

Clone the repository:

```bash
git clone https://github.com/gsoft-inc/sg-browserslist.git
```

Then, install the dependencies with Yarn:

```bash
yarn install
```

### Release

Before you release, make sure you have **write access** for all the NPM packages that will be published and that you are [logged in to NPM](https://docs.npmjs.com/logging-in-to-an-npm-enterprise-registry-from-the-command-line).

To release, open a terminal at the root project of the workspace and execute the following:

```bash
yarn release
```

## License

Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-lodash
Description: Sharegate lodash ESLint config.
Author: Groupe Sharegate inc.
Latest version: 1.1.0
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-lodash

Sharegate [lodash](https://github.com/wix/eslint-plugin-lodash) ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-nextjs
Description: Sharegate Nextjs ESLint config.
Author: Groupe Sharegate inc.
Latest version: 3.0.1
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-nextjs

Sharegate Nextjs ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-react
Description: Sharegate React ESLint config.
Author: Groupe Sharegate inc.
Latest version: 5.0.1
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-react

Sharegate React ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-recommended
Description: Sharegate recommended ESLint config.
Author: Groupe Sharegate inc.
Latest version: 3.0.1
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-recommended

Sharegate recommended ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-sort-imports
Description: Sharegate sort-imports ESLint config.
Author: Groupe Sharegate inc.
Latest version: 1.1.0
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-sort-imports

Sharegate [sort-imports](https://www.npmjs.com/package/eslint-plugin-sort-imports-es6-autofix) ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-strict
Description: Sharegate strict ESLint config.
Author: Groupe Sharegate inc.
Latest version: 1.1.0
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-strict

Sharegate's strict ESLint config.

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-config-typescript
Description: Sharegate TypeScript ESLint config.
Author: Groupe Sharegate inc.
Latest version: 4.0.1
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# eslint-config-typescript

Sharegate TypeScript ESLint config.

## Usage

If you are also using React, you might have to add the following ESLint rule:

```js
rules: {
    "react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx", ".ts", ".tsx"] }]
}
```

## License

Copyright © 2019, Groupe Sharegate inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-plugin-apricot
Description: ShareGate Apricot's custom ESLint plugin.
Author: Groupe Sharegate inc.
Latest version: 1.2.1

# sg-apricot-eslint

Sharegate Apricot's custom ESLint plugin.

## Installation

Install the ShareGate recommended ESLint configuration packages.

With NPM:

```json
npm i -D eslint babel-eslint @sharegate/eslint-plugin-apricot
```

## Usage

Add `apricot` to the plugins section of your `.eslintrc.js` configuration file.

```json
{
    "plugins": [
        "@sharegate/apricot"
    ]
}
```


Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "@sharegate/apricot/rule-name": "warn"
    }
}
```

## Plugin-Provided Rules

Sharegate's plugin provides the following custom rules, which are included as appropriate in all core linting configs:

- [require-register-function-in-handlers](docs/rules/require-register-function-in-handlers.md): All handlers.js file must export a registration function named registerHandlers.
- [require-register-function-in-reducers](docs/rules/require-register-function-in-reducers.md): All reducers.js file must export a registration function named registerReducers.
- [require-register-function-in-registration](docs/rules/require-register-function-in-registration.md) : All registration.js file must export a registration function.
- [no-relative-path-to-parent-directory](docs/rules/no-relative-path-to-parent-directory.md) : Relative path to parent directories in import statements are not allowed.
- [strict-component-boundaries](docs/rules/strict-component-boundaries.md) : Do not reach into an individual component's folder for nested modules.
- [strict-file-names](docs/rules/strict-file-names.md) : Do not name files with names that don't respect the naming convention.
- [no-class-components](docs/rules/no-class-components.md) : Class components are forbidden. Use a Functional Component instead.

## Maintainers

The following documentation is only for the maintainers of this repository.

### Rule Creation

In order to create a new rule, you must manually create 3 new files :

- The rule's definition : lib/rules/RULE_ID.js
- The rule's test file : tests/lib/rules/RULE_ID.test.js
- The rule's documentation: docs/rules/RULE_ID.md

You must also :
- Add the rule's documentation in this README in the Plugin-Provided Rules section.

## License

Copyright © 2019, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/eslint-plugin-rules
Description: Sharegate's custom ESLint plugin.
Author: Groupe Sharegate inc.
Latest version: 1.4.0
Deprecated: Package no longer supported. Use @sharegate/eslint-plugin instead.

# @sharegate/eslint-plugin-rules

Sharegate's custom ESLint plugin.

## Usage

Add the sharegate rules plugin to your .eslintrc configuration file.

```javascript
{
    plugins: ["@sharegate/rules"]
}
```

Then configure the rules you want to use under the rules section.

```javascript
{
    rules: {
        "@sharegate/rules/rule-name": "warn"
    }
}
```

## Maintainers

The following documentation is only for the maintainers of this repository.

### Rule Creation

In order to create a new rule, you must manually create 3 new files :

- the rule's definition : packages\plugin\lib\rules\[RULE_ID].js
- the rule's test file : packages\plugin\tests\lib\rules\[RULE_ID].test.js
- the rule's documentation: packages\plugin\docs\rules\[RULE_ID].md

And add the rule's documentation in the workspace's [README](../../README.md) in the Plugin-Provided Rules section.
npm package: @sharegate/navigation
Description: This project is intended for internal use on ShareGate project. It includes the layout, aside navigation, header navigation and all of the linked items.
Latest version: 2.0.0

# Introduction 
This project is intended for internal use on ShareGate project. It includes the layout, aside navigation, header navigation and all of the linked items.

# Getting Started
This repo contains the components and a storybook to document those components

1.	Installation process

Simply run a good old `npm i` to get the project setup on your machine, then run `npm run storybook` to access the storybook.

2.	Dependencies

This project is built using Orbit design system

3. Folder sturcture

The project uses 2 folders:
- `src`, including all the components to build
- `stories`, stories around the components in the `src` folder.

4.	Latest releases

January 31, 2023

# Build
To build the project, run `npm run build` to generate components and assets files.

# Contribute
This project is for internal use only.
npm package: @sharegate/orbit-ui
Description: Orbit design system
Author: Groupe ShareGate inc.
Latest version: 35.0.3

# @sharegate/orbit-ui

Full documentation available at: https://orbit.sharegate.design

## License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/postcss-plugin
Description: Sharegate recommended PostCSS config.
Author: Groupe ShareGate inc.
Latest version: 2.0.1

# `@sharegate/postcss-plugin`

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE.md)
[![npm version](https://img.shields.io/npm/v/@sharegate/postcss-plugin)](https://www.npmjs.com/package/@sharegate/postcss-plugin)

All of ShareGate’s preferred PostCSS plugins wrapped up in a single, easy-to-use plugin.

## Installation

Install the package.

**With npm**
```shell
npm i --save-dev @sharegate/postcss-plugin
```

**With yarn**
```shell
yarn add --dev @sharegate/postcss-plugin
```

## Features

This plugin wraps around the following PostCSS transformations:

- [`postcss-flexbugs-fixes`](https://github.com/luisrudge/postcss-flexbugs-fixes)
- [`postcss-preset-env`](https://github.com/csstools/postcss-preset-env)
- [`postcss-pxtorem`](https://github.com/cuth/postcss-pxtorem)

## Usage

Create a `postcss.config.js` file at the root of your project with the following content:
```js
/** @type {import('postcss').Postcss} */
module.exports = {
    plugins: ["@sharegate/postcss-plugin"]
};
```

## License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/stylelint-plugin
Description: Sharegate recommended stylelint config.
Author: Groupe ShareGate inc.
Latest version: 1.0.1

# `@sharegate/stylelint-plugin`

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE.md)
[![npm version](https://img.shields.io/npm/v/@sharegate/stylelint-plugin)](https://www.npmjs.com/package/@sharegate/stylelint-plugin) 

Shareable [browserslist](https://github.com/browserslist/browserslist) configuration for ShareGate.

## Installation

Install the package.

**With npm**
```shell
npm i --save-dev @sharegate/stylelint-plugin
```

**With yarn**
```shell
yarn add --dev @sharegate/stylelint-plugin
```

## Supported Browsers

You can list all supported browsers by following this link:
https://browsersl.ist/#q=last+1+year%2C+%3E+0.2%25%2C+Firefox+ESR%2C+not+dead%2C+not+op_mini+all

## Usage

Create a `stylelint.config.js` file at the root of your project with the following content:
```js
/** @type {import('stylelint').Config} */
module.exports = {
    extends: "@sharegate/stylelint-plugin",
    defaultSeverity: "warning",
};
```

## License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.
npm package: @sharegate/typescript-config
Description: Sharegate recommended typescript config.
Author: Groupe ShareGate inc.
Latest version: 1.1.1

# `@sharegate/typescript-config`

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE.md)
[![npm version](https://img.shields.io/npm/v/@sharegate/typescript-config)](https://www.npmjs.com/package/@sharegate/typescript-config)

This packages provides a base TypeScript configuration depending on the JavaScript runtime environment which you intend to run your code in. 
These are tsconfig.json files which your project extends from which simplifies your tsconfig.json by handling the runtime support.

## Installation

Install the package.

**With npm**
```shell
npm i --save-dev @sharegate/typescript-config
```

**With yarn**
```shell
yarn add --dev @sharegate/typescript-config
```

## Usage

### Create React App Project

To start, create a tsconfig.json in the root of your project.

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/cra.json",
  "compilerOptions": {
    "baseUrl": ".",
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}
```

### NextJS Project

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/nextjs.json",
  "compilerOptions": {
    "baseUrl": ".",
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}
```

### React Library Project

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/react-library.json",
  "compilerOptions": {
    "baseUrl": ".",
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}
```

### Other type of React Project

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/react.json",
  "compilerOptions": {
    "baseUrl": ".",
  }
}
```

### TypeScript Library

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/library.json",
  "compilerOptions": {
  }
}
```

### All Other TypeScript Projects

```json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": "@sharegate/typescript-config/base.json",
  "compilerOptions": {
  }
}
```

## License

Copyright © 2023, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE.