# @lordlingham/create-tealium-tool

> A CLI to bootstrap custom Tealium Tools

Latest version **1.0.2** (published 2022-04-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @lordlingham/create-tealium-tool
pnpm add @lordlingham/create-tealium-tool
yarn add @lordlingham/create-tealium-tool
bun add @lordlingham/create-tealium-tool
```

Provides the command `create-tealium-tool`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-04-19 |
| First published | 2022-04-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | james.lingham@tealium.com |
| Maintainers | lordlingham |
| Keywords | cli, create-tealium-tool |

## Links

- npm: https://www.npmjs.com/package/@lordlingham/create-tealium-tool
- npm.io page: https://npm.io/package/@lordlingham/create-tealium-tool

## Dependencies (6)

- [arg](https://npm.io/package/arg.md) ^5.0.0
- [esm](https://npm.io/package/esm.md) ^3.2.25
- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [@lordlingham/create-tealium-tool](https://npm.io/package/@lordlingham/create-tealium-tool.md) ^1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-04-19
- 1.0.0 — 2022-04-19

## README

# create-tealium-tool

create-tealium-tool allows for you to create template files for custom Tealium tools.

## Usage

Install the tool globally using `npm i -g @lordlingham/create-tealium-tool`
Navigate to your destination directory and then generate your starter files using `create-tealium-tool`

**For example**

> npm i -g @lordlingham/create-tealium-tool
> mkdir my_tool && cd my_tool`
> create-tealium-tool


You will be prompted to answer a few basic questions about the tool, which will populate the template files.

The following files will be generated.

**tool.json**
This file will contain your setup information about the tool, and generally does not need to be modified.

**ui.html**
This will be a template file - You will want to edit this to provide a UI within the extension popup. We use Handlebars to generate the output when the tool is in use.

**page.js**
This file will be the main star of the show. This will be the JavaScript which executes the functionality of the tool, and if required - pass messages back to the extension popup to be displayed within the template defined in ui.html
This template file contains basic checks against the page the tool is being ran on for TIQ or CDH. Any other rules should be easy to change - You can modify or remove these checks if necessary.


    

## Predefined functions

|Function|Description|
|--|--|
| main | The main function that runs when the tool is messaged. Generally this contains a switch statement checking for a `command` property and acts accordingly.
log  | Used to send messages from the window to the extension
ui_state| Helps control the UI State of the extension, use this to easily switch between views / stages of user interaction within the UI.
error| Records / sends error message and updates the UI State
makeProgressCircle| Updates the UI State to "ui_wait" which adds a CSS Spinner
makeFinishCircle| Updates the UI state to "ui_finish" which removes the associated CSS Spinner


## Further Reading

https://community.tealiumiq.com/t5/Technical-Solutions/Tealium-Tools-Framework/m-p/15688
https://community.tealiumiq.com/t5/Developer-Tools/Creating-Custom-Tealium-Tools/ta-p/332

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