# magicalstrings

> constants and a few incantations for dealing with genies

Latest version **1.1.0** (published 2021-05-28) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-05-28 |
| First published | 2021-01-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 84 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | yisroel |

## Links

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

## Dependencies (12)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [pluralize](https://npm.io/package/pluralize.md) ^8.0.0
- [inflection](https://npm.io/package/inflection.md) ^1.12.0
- [node-emoji](https://npm.io/package/node-emoji.md) ^1.10.0
- [typescript](https://npm.io/package/typescript.md) ^4.1.3
- [@types/node](https://npm.io/package/@types/node.md) ^14.14.19
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.0.1
- [resolve-dir-fixed](https://npm.io/package/resolve-dir-fixed.md) ^1.0.0

## Recent versions

- 1.1.0 (latest) — 2021-05-28
- 0.1.0 — 2021-05-20
- 0.0.16 — 2021-04-09
- 0.0.15 — 2021-04-09
- 0.0.14 — 2021-02-17
- 0.0.13 — 2021-01-13
- 0.0.12 — 2021-01-11
- 0.0.11 — 2021-01-06
- 0.0.10 — 2021-01-05
- 0.0.9 — 2021-01-05
- 0.0.8 — 2021-01-05
- 0.0.7 — 2021-01-05
- 0.0.6 — 2021-01-05
- 0.0.5 — 2021-01-05
- 0.0.4 — 2021-01-04
- … 3 more at https://npm.io/package/magicalstrings/versions

## README

A lot of constants and some incantations for working with genies. Used with [geenee](https://www.npmjs.com/package/geenee) tools.

![magicalstrings gif](images/magicalstrings-new.gif)

You probably won't need to include this directly.  It would make more sense to use tools that access it, such as [copyKat](https://www.npmjs.com/package/copykat).

<!-- toc -->
* [:pushpin: API](#api)
* [:paperclip: Types](#types)
* [:file_folder: Config Files](#config-files)
* [:wrench: Settings](#settings)
* [:triangular_ruler: Constants](#constants)
* [:bookmark: RegEx](#regex)
* [:memo: Functions](#functions)
  <!-- tocstop -->

# <a name="api"></a>:pushpin: API
{This will be filled out soon.}
## <a name="types"></a>:paperclip: Types
Interfaces.
### Configuration
Configuration and subTypes

### Settings (nsInfo)
NsInfo and subTypes
### Backend (schema)
Schema and subTypes

### Custom
CustomCodeByFile and subTypes

### General
* Delimiter
* BoilerPlateInfoType

## <a name="config-files"></a>:file_folder: Config Files
There are 3 functions for working with config files.
```
const {getConfig} = require('magicalstrings').configs 
```
```
const {setConfig} = require('magicalstrings').configs 
```
```
const {getIgnoredList} = require('magicalstrings').configs 
```


## <a name="settings"></a>:wrench: Settings
These functions are for retrieving and updating settings.
```
getNsInfo
```
```
setNsInfo
```

## <a name="constants"></a>:triangular_ruler: Constants
A lot of these constants are being moved out gradually to more relevant packages.

### chalkColors
A number of terms used consistently in the UI.

### fileOptions

### parseSpecName

### configuration

### Other Constants

## Types
### custom
custom

### schema
Please note: the `Schema` type has been moved to the [stack-info](https://www.npmjs.com/package/stack-info) package.  This is a **Breaking Change**!!!

### dingbats
```
dingKats 
```

### nsInfo
nsInfo

## <a name="regex"></a>:bookmark: RegEx
A number of Regex utilities.

* regExCleanupText
* regExCustomCleanup
* regExCustomLocation
* regExFileInfo
* regExNewCustomLocation
* regExReplacedCodeSection
* regExObjectValueString
* regExShared
* regExTemplateAbbreviation

## <a name="functions"></a>:memo: Functions
Several functions used by genies and copykats.

* inflections
* testCodeDir
* isRequired
* ensureDirectory
* codeNameFromPath
* resolveDir
* inflections
* dirOptions
* removeNpmDependencyPrefix
* copyCodeBaseToNewDir
* fileMatchesCustomFileFilter
* moveOverIgnored
* errorMessage

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