# oxmodule

> Create oXID module template/skeleton

Latest version **0.3.1** (published 2023-06-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install oxmodule
pnpm add oxmodule
yarn add oxmodule
bun add oxmodule
```

Provides the command `oxmodule`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2023-06-07 |
| First published | 2022-08-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 62.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | info@itholics.de |
| Maintainers | itholics |
| Keywords | oxid, module, skeleton, blueprint, template |

## Links

- npm: https://www.npmjs.com/package/oxmodule
- Repository: https://github.com/itholics/oxmodule
- Homepage: https://github.com/itholics/oxmodule#readme
- Issues: https://github.com/itholics/oxmodule/issues
- npm.io page: https://npm.io/package/oxmodule

## Dependencies (1)

- [prompt-sync](https://npm.io/package/prompt-sync.md) ^4.2.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.3.1 (latest) — 2023-06-07
- 0.3.0 — 2023-06-05
- 0.2.0 — 2022-11-24
- 0.1.6 — 2022-08-30
- 0.1.5 — 2022-08-19
- 0.1.4 — 2022-08-18
- 0.1.3 — 2022-08-17
- 0.1.2 — 2022-08-17
- 0.1.0 — 2022-08-17

## README

# [ITholics'](https://www.itholics.de) oxmodule

## Introduction

Helper to create module (v2.1) skeleton for [oXID](https://www.oxid-esales.com/) written for NodeJS.

## Usage
You may install it globally:

    npm install -g oxmodule
    oxmodule

or better:
    
    npx oxmodule

If the module structure is like:
- modules
  - vendor
    - module_name1
    - module_name2
  
You will be asked for the installation path (defaults to current directory). You can provide the `modules/` or `modules/vendor/` if 
the target-directory is f.e. `vendor/module_name3`. Tt will add the module_name3 to the vendor folder.
If the vendor das not exist, you must provide the `modules/` folder.

In the process of creation it will ask you some questions about the module you like to create:
- composer naming
- target directory naming
- module id
- etc...

You should be in the `<SHOP>/source/modules` or `<SHOP>/source/modules/<YOUR_VENDOR>` directory or providing this directory in the process.

## Skeleton
- `TARGET_VENDOR`
    - `TARGET_NAME`
      - Application
        - Component
          - Widget
        - Controller
          - Admin
        - Core
          - Module.php
        - Model
        - translations (optional)
          - de
            - `ID`_de_lang.php
          - en
            - `ID`_en_lang.php
          - es
            - `ID`_es_lang.php
          - fr
            - `ID`_fr_lang.php
          - it
            - `ID`_it_lang.php
        - views
          - admin (oxid `<7`)
            - de
              - `ID`_admin_de_lang.php
            - en
              - `ID`_admin_en_lang.php
            - tpl
          - admin_smarty (oxid `>=7`)
            - de
              - `ID`_admin_de_lang.php
            - en
              - `ID`_admin_en_lang.php
            - tpl
          - admin_twig (oxid `>=7`)
            - de
              - `ID`_admin_de_lang.php
            - en
              - `ID`_admin_en_lang.php
            - tpl
          - blocks
          - tpl
      - bin
        - install.sh
        - update.sh
        - remove.sh
      - docs
      - out (oxid `<7`)
      - assets (oxid `>=7`)
      - Smarty
      - composer.json
      - metadata.php
      - README.md

## Changelog
[View Changelog here.](./CHANGELOG.md)

---
_Source: https://npm.io/package/oxmodule · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._