The kebab Reference Manual

This is the kebab Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:50:13 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 kebab

Common Lisp string,symbol,keyword PascalCase <=> camelCase <=> snake_case <=> kebab-case(lisp-case) converter.

Author

Masato Sogame

License

LLGPL

Long Description

# Kebab

Common Lisp string,symbol,keyword PascalCase <=> camelCase <=> snake_case <=> kebab-case(lisp-case) converter.

## Usage

“‘lisp
(to-camel-case "snake_case")
# => "snakeCase"

(to-snake-case "camelCase")
# => "camel_case"

(to-pascal-case "snake_case")
# => "SnakeCase"

(to-kebab-case "snake_case")
# => "snake-case"

(to-lisp-case "snake_case")
# => "snake-case"
“‘

## Installation

## API

- to-camel-case
- to-snake-case
- to-pascal-case
- to-kebab-case
- to-lisp-case

## Author

* Masato Sogame (poketo7878@gmail.com)

## Copyright

Copyright (c) 2015 Masato Sogame (poketo7878@gmail.com)

## License

Licensed under the LLGPL License.

Version

0.1

Dependencies
  • cl-ppcre (system).
  • cl-interpol (system).
  • alexandria (system).
  • split-sequence (system).
Source

kebab.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 kebab/src

Source

kebab.asd.

Parent Component

kebab (system).

Child Component

kebab.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 kebab/kebab.asd

Source

kebab.asd.

Parent Component

kebab (system).

ASDF Systems

kebab.

Packages

kebab-asd.


4.1.2 kebab/src/kebab.lisp

Source

kebab.asd.

Parent Component

src (module).

Packages

kebab.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 kebab-asd

Source

kebab.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 kebab

Source

kebab.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: to-camel-case (g0)
Package

kebab.

Source

kebab.lisp.

Function: to-kebab-case (g0)
Package

kebab.

Source

kebab.lisp.

Function: to-lisp-case (g0)
Package

kebab.

Source

kebab.lisp.

Function: to-pascal-case (g0)
Package

kebab.

Source

kebab.lisp.

Function: to-snake-case (g0)
Package

kebab.

Source

kebab.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *separators*
Package

kebab.

Source

kebab.lisp.


6.2.2 Macros

Macro: define-converter (case-name head-fn rest-fn sep)
Package

kebab.

Source

kebab.lisp.


6.2.3 Ordinary functions

Function: classify-char (char)
Package

kebab.

Source

kebab.lisp.

Function: classify-string (string)
Package

kebab.

Source

kebab.lisp.

Function: convert-case (string head-fn rest-fn separator)
Package

kebab.

Source

kebab.lisp.

Function: join (sep str-list)
Package

kebab.

Source

kebab.lisp.

Function: save-type-convert-case (val head-fn rest-fn separator)
Package

kebab.

Source

kebab.lisp.

Function: split (string)
Package

kebab.

Source

kebab.lisp.

Function: split-classified-string (classified-string)
Package

kebab.

Source

kebab.lisp.

Function: split-on-case (classified-string)
Package

kebab.

Source

kebab.lisp.

Function: split-on-separator (classified-string)
Package

kebab.

Source

kebab.lisp.

Function: unclassify-string (classified-string)
Package

kebab.

Source

kebab.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   J   M   S   T   U  
Index Entry  Section

C
classify-char: Private ordinary functions
classify-string: Private ordinary functions
convert-case: Private ordinary functions

D
define-converter: Private macros

F
Function, classify-char: Private ordinary functions
Function, classify-string: Private ordinary functions
Function, convert-case: Private ordinary functions
Function, join: Private ordinary functions
Function, save-type-convert-case: Private ordinary functions
Function, split: Private ordinary functions
Function, split-classified-string: Private ordinary functions
Function, split-on-case: Private ordinary functions
Function, split-on-separator: Private ordinary functions
Function, to-camel-case: Public ordinary functions
Function, to-kebab-case: Public ordinary functions
Function, to-lisp-case: Public ordinary functions
Function, to-pascal-case: Public ordinary functions
Function, to-snake-case: Public ordinary functions
Function, unclassify-string: Private ordinary functions

J
join: Private ordinary functions

M
Macro, define-converter: Private macros

S
save-type-convert-case: Private ordinary functions
split: Private ordinary functions
split-classified-string: Private ordinary functions
split-on-case: Private ordinary functions
split-on-separator: Private ordinary functions

T
to-camel-case: Public ordinary functions
to-kebab-case: Public ordinary functions
to-lisp-case: Public ordinary functions
to-pascal-case: Public ordinary functions
to-snake-case: Public ordinary functions

U
unclassify-string: Private ordinary functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*separators*: Private special variables

S
Special Variable, *separators*: Private special variables