npm.io
1.1.0 • Published 5 years ago

magicalstrings

Licence
ISC
Version
1.1.0
Deps
12
Size
84 kB
Vulns
0
Weekly
0
Stars
1

A lot of constants and some incantations for working with genies. Used with geenee tools.

magicalstrings gif

You probably won't need to include this directly. It would make more sense to use tools that access it, such as copyKat.

API

{This will be filled out soon.}

Types

Interfaces.

Configuration

Configuration and subTypes

Settings (nsInfo)

NsInfo and subTypes

Backend (schema)

Schema and subTypes

Custom

CustomCodeByFile and subTypes

General
  • Delimiter
  • BoilerPlateInfoType

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 

Settings

These functions are for retrieving and updating settings.

getNsInfo
setNsInfo

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 package. This is a Breaking Change!!!

dingbats
dingKats 
nsInfo

nsInfo

RegEx

A number of Regex utilities.

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

Functions

Several functions used by genies and copykats.

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