open-index/open-npm huggingface dataset:
npm package: @outsystems/assistant
Description: A CLI tool to help you with your OutSystems development tasks.
Author: OutSystems
Latest version: 0.0.8

# OutSystems Development Assistant

This package provides a CLI utility that helps to comply with development policies and best practices at OutSystems when developing in a Node.js environment. It includes:

* 🔐 Setup your package manager to properly connect to OutSystems Artifactory
* 🤐 Downloads environment variables to access 3rd party services you need as developer
* 💅 Provides an Eslint configuration to help align with our code standards and best practices

## Install

You can install this package via:

```sh
npm install @outsystems/assistant
```

## Usage

This package provides a CLI command as well as utilities you can import in your Node.js environment.

### CLI

The CLI currently offers a `login` command that authenticates you with OutSystems Azure environment. Run it via:

```sh
# setup `.npmrc` file to access OutSystem packages
npx os login
```

After you've successfully walked through the configuration wizard the tool will:

- set up an `.npmrc` or `.yarnrc` to pull packages from the OutSystem Artifactory
- create an `.env` file will with credentials for using Sauce Labs and other vendor services

### Eslint

This framework provides a basic configuration for [Eslint](https://eslint.org/) that your project can use without having to set it up yourself. It comes with recommended standards for consistent code quality.

To set this up for your project, first, install ESLint in your project:

```sh
npm i --save-dev eslint
```

Then create a `eslint.config.mjs` in the root of your project with the following content:

```js
import oslint from '@outsystems/assistant/eslint';

export default oslint.config(
    [
        {
            // optional custom configs go in here
        }
    ]
)
```

## Contributing

You want to help make this framework better? Awesome! Have a look into our [Contributor Documentation](./CONTRIBUTING.md) to get started and how to you can make contributions to this project.

---

©️ Copyright 2024 OutSystems, all rights reserved.