open-index/open-npm huggingface dataset:
npm package: @heyframe-ag/admin-stylelint-rules
Description: This package provides custom stylelint rules for HeyFrame Administration development.
Latest version: 1.0.5

# Stylelint Rules for HeyFrame Administration

This package provides custom stylelint rules for HeyFrame Administration development.

## Installation

Install the package and its peer dependency `stylelint`:

```bash
npm install @heyframe-ag/admin-stylelint-rules stylelint --save-dev
```

## Usage

Add the plugin to your stylelint configuration file (e.g., `.stylelintrc.json`) and configure the rules you want to use.

```json
{
  "plugins": [
    "@heyframe-ag/admin-stylelint-rules"
  ],
  "rules": {
    "@heyframe-ag/admin-stylelint-rules/wrong-scss-import": true
  }
}
```

## Rules

### `@heyframe-ag/admin-stylelint-rules/wrong-scss-import`

This rule prevents the use of the `.scss` file extension in `@import` statements that start with `~scss`. It encourages a consistent import style for shared SCSS resources.

This rule can automatically fix violations.

**Example of incorrect code for this rule:**

```scss
@import "~scss/variables.scss";
@import '~scss/mixins.scss';
```

**Example of correct code for this rule:**

```scss
@import "~scss/variables";
@import '~scss/mixins';
```
npm package: @heyframe-ag/frontend-eslint-rules
Description: HeyFrame Frontend ESLint rules
Latest version: 1.0.5

# ESLint Rules for HeyFrame Frontend

This package provides custom ESLint rules for HeyFrame Frontend projects. These rules help to ensure code quality, promote best practices, and assist in migrating from older code patterns to more modern approaches.

## Installation

```
npm install @heyframe-ag/frontend-eslint-rules --save-dev
```

## Usage

Add the following to your ESLint configuration file (e.g., .eslintrc.js):

```diff
+import frontendRules from '@heyframe-ag/frontend-eslint-rules';

/** @type {import('eslint').Linter.Config[]} */
export default [
  {languageOptions: { globals: globals.browser }},
  pluginJs.configs.recommended,
  ...tseslint.configs.recommended,
+  frontendRules,
  {
    rules: {
      '@typescript-eslint/no-unused-vars': 'warn',
      '@typescript-eslint/no-unused-expressions': 'warn',
      '@typescript-eslint/no-this-alias': 'warn',
      '@typescript-eslint/no-require-imports': 'off',
      'no-undef': 'off',
      'no-alert': 'error',
      'no-console': ['error', { allow: ['warn', 'error'] }],
    }
  }
];
```

## Rules

- `migrate-plugin-manager`: This rule flags imports from src/plugin-system/plugin.manager and suggests using window.PluginManager instead. It also flags imports from src/plugin-system/plugin.class and suggests using window.PluginBaseClass.
- `no-dom-access-helper`: This rule identifies usages of the DomAccessHelper and suggests using native DOM methods instead.
- `no-http-client`: This rule identifies usages of the HttpClient and suggests using the fetch API instead.
- `no-query-string`: This rule identifies usages of the query-string library and suggests using URLSearchParams instead.
npm package: @heyframe-ag/meteor-component-library
Description: The meteor component library is a Vue component library developed by HeyFrame. It is based on the [Meteor Design System](https://heyframe.design/).
Author: heyframe AG
Latest version: 4.18.0

# Meteor component library

The meteor component library is a Vue component library developed by HeyFrame. It is based on the [Meteor Design System](https://heyframe.design/).

- Perfect suitable for HeyFrame Apps
- Matches the HeyFrame administration look and feel
- Small bundle sizes with tree-shaking
- Completely tested and [documented](https://meteor-component-library.vercel.app/) with Storybook

## Requirements

You need a working **Vue 3 application** with the **i18n plugin** for the translations. The main translations (English and German) are bundled in the components. For other languages you need to add the snippets for the correct paths.

## Installation

Add this package to your project:

```cli
npm i @heyframe-ag/meteor-component-library
```

Import the `style.css` for general styling and `font.css` for the Inter font in the root file of your application or in you root styling file.

```js
import "@heyframe-ag/meteor-component-library/styles.css";
import "@heyframe-ag/meteor-component-library/font.css";
```

Each component works independently and can be imported directly from the root like this:

```html
<script>
  import { MtButton } from "@heyframe-ag/meteor-component-library";

  export default {
    components: {
      "mt-button": MtButton,
    },
  };
</script>
```

## Development

These guides are useful if you want to contribute this component library.

### Project setup

```shell
pnpm install
```

#### Compiles and hot-reloads for development

```shell
pnpm run storybook
```

#### Compiles and minifies for production

```shell
pnpm run build:storybook
```

#### Run your interaction tests (running Storybook instance is needed)

```shell
pnpm run test:storybook
```

#### Lints and fixes files

```shell
pnpm run lint:all
```

#### Build the bundled component library

```shell
pnpm run build
```

### Writing interaction tests

All interaction tests are written in `component-name.interactive.stories.js` files. The title needs to be prefixed with `Interaction Tests/`. These interaction tests are hidden in the final build but are visible in the Storybook development watcher.

Example:

```js
import meta from "./mt-button.stories";

export default {
  ...meta,
  title: "Interaction Tests/base/mt-button",
  component: MtButton,
};
```

### Writing visual tests

Stories for visual tests need to start with `VisualTest`.

Example:

```js
export const VisualTestPrimaryVariant = {
  name: "Render the primary variant",
  play: async ({ canvasElement }) => {
    const canvas = within(canvasElement);

    // your interaction test ...
  },
};
```

The screenshot will be generated at the end of the Play function. If no Play function is defined then it will be created immediately.

For reduced flakiness all animations are automatically disabled from Playwright.