@barudakrosul/textwrap

TextWrap

English

Laporkan Bug · Ajukan Fitur

Daftar Isi

1. Pendahuluan
2. Fitur
3. Instalasi
4. Penggunaan
5. Berkontribusi
6. Lisensi
7. Penghargaan
8. Donasi
9. Catatan Perubahan

Pendahuluan

TextWrap adalah implementasi JavaScript dari modul textwrap yang tersedia di Python, yang menyediakan beberapa fungsi untuk membungkus dan memformat paragraf teks dengan panjang baris yang dibatasi. Modul ini berguna untuk memformat teks agar lebih mudah dibaca atau untuk kebutuhan tampilan.

Fitur

TextWrap menawarkan fitur-fitur berikut:

• Teks Wrap: Membungkus teks menjadi beberapa baris (dengan tipe array) sesuai dengan lebar yang diberikan.
• Teks Fill: Membungkus teks seperti wrap, tetapi mengembalikan teks yang sudah dibungkus sebagai satu string, dengan baris-baris dipisahkan oleh karakter newline (\n).
• Teks Shorten: Membungkus teks menjadi satu baris dengan lebar maksimum yang diberikan, menggantikan bagian akhir teks dengan placeholder jika teks terlalu panjang.
• Teks Dedent: Menghapus indentasi umum dari setiap baris dalam teks yang diberikan.
• Teks Indent: Menambahkan string prefix (indentasi) di awal setiap baris dari teks yang diberikan. Opsi predicate dapat digunakan untuk mengontrol baris mana yang akan diberi prefix.

Instalasi

Untuk menginstal TextWrap secara lokal, ikuti langkah instalasi ini:

npm install @barudakrosul/textwrap

Penggunaan

Untuk memulai menggunakan TextWrap, import modulnya terlebuh dahulu:

1. CommonJS

const textwrap = require("@barudakrosul/textwrap");

2. ESM (ECMAScript Modules)

import textwrap from "@barudakrosul/textwrap";

Contoh penggunaan:

Teks Wrap

console.log(textwrap.wrap("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 11))

// Result:
//   [
//     'Lorem ipsum', 'dolor sit',
//     'amet,',       'consectetur',
//     'adipisicing', 'elit, sed',
//     'do eiusmod',  'tempor',
//     'incididunt',  'ut labore',
//     'et dolore',   'magna',
//     'aliqua.'
//   ]

Teks Fill

console.log(textwrap.fill("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 11))

// Result:
//   Lorem ipsum
//   dolor sit
//   amet,
//   consectetur
//   adipisicing
//   elit, sed
//   do eiusmod
//   tempor
//   incididunt
//   ut labore
//   et dolore
//   magna
//   aliqua.

Teks Shorten

console.log(textwrap.shorten("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", 59))

// Result:
//   Lorem ipsum dolor sit amet, consectetur adipisicing [...]

Teks Dedent

console.log(textwrap.dedent("Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua."))

// Result:
//   Lorem ipsum dolor sit amet,
//   consectetur adipisicing elit,
//   sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Teks Indent

console.log(textwrap.indent("Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "> "))

// Result:
//   > Lorem ipsum dolor sit amet,
//   > consectetur adipisicing elit,
//   > sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Contoh menambahkan prefix untuk setiap newline, termasuk yang kosong:

console.log(textwrap.indent("Lorem ipsum dolor sit amet,\n\n\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "> ", lines => true))

// Result:
//   > Lorem ipsum dolor sit amet,
//   >
//   >
//   > consectetur adipisicing elit,
//   > sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Contoh menambahkan prefix untuk setiap baris yang dimulai dengan string tertentu secara spesifik:

console.log(textwrap.indent("Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "> ", lines => lines.startsWith("Lorem")))

// Result:
//   > Lorem ipsum dolor sit amet,
//   consectetur adipisicing elit,
//   sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Contoh menambahkan prefix untuk setiap baris yang terdapat string tertentu secara spesifik:

console.log(textwrap.indent("Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "> ", lines => lines.includes(",")))

// Result:
//   > Lorem ipsum dolor sit amet,
//   consectetur adipisicing elit,
//   sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Contoh menambahkan prefix untuk setiap baris yang yang memiliki batas panjang tertentu:

console.log(textwrap.indent("Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit,\nsed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "> ", lines => lines.length > 28))

// Result:
//   Lorem ipsum dolor sit amet,
//   > consectetur adipisicing elit,
//   > sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Untuk fungsi wrap(), fill(), dan shorten() mempunyai opsi tambahan. Adapun, opsi yang didukung di antaranya:

Nama	Keterangan	Tipe	Nilai default
width	Lebar maksimum baris yang dibungkus (kecuali break_long_words adalah false).	number	70
initial_indent	String indentasi untuk baris pertama.	string	""
subsequent_indent	String indentasi untuk baris-baris berikutnya.	string	""
expand_tabs	Jika true, tab akan digantikan dengan spasi.	boolean	true
replace_whitespace	Jika true, karakter whitespace akan digantikan dengan spasi.	boolean	true
fix_sentence_endings	Jika true, dua spasi akan ditambahkan setelah tanda titik di akhir kalimat.	boolean	false
break_long_words	Jika true, kata-kata yang lebih panjang dari lebar baris akan dipecah.	boolean	true
drop_whitespace	Jika true, whitespace di awal dan akhir baris akan dihapus.	boolean	true
break_on_hyphens	Jika true, teks akan dipecah pada tanda hubung.	boolean	true
tabsize	Ukuran tab dalam karakter.	number	8
max_lines	Jumlah maksimum baris.	number | null	null
placeholder	String yang digunakan untuk menggantikan bagian akhir teks jika terlalu panjang.	string	[...]

Contoh dasar penggunaan opsi tersebut:

const text = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.";
const width = 20;
const options = {
  fix_sentence_endings: true,
  break_long_words: false
};

console.log(textwrap.wrap(text, width, options));

Berkontribusi

Kontribusi pada TextWrap sangat dihargai! Baik melaporkan bug, menyarankan fitur baru, atau berkontribusi pada perbaikan kode.

Lisensi

TextWrap dilisensikan di bawah Lisensi MIT - lihat berkas LICENSE untuk detailnya.

Penghargaan

TextWrap menghargai dukungan dan kontribusi dari individu dan proyek sumber terbuka berikut:

• @FajarKim - Pengembang utama dan pencipta aplikasi.
• Modul TextWrap Python - Sumber asli dalam pengembangan TextWrap JavaScript.
• Komunitas sumber terbuka - Untuk kontribusi berharga pada alat dan perpustakaan yang digunakan dalam proyek ini.

Donasi

Kami sangat menghargai dukungan Anda untuk terus mengembangkan proyek ini. Jika Anda merasa proyek ini bermanfaat, Anda dapat mendukung kami dengan donasi:

Setiap donasi, berapapun jumlahnya, sangat berarti bagi kami. Terima kasih atas dukungan Anda! ❤️

Catatan Perubahan

Terus ikuti perubahan dan pembaruan terbaru TextWrap dengan mengacu ke Catatan Perubahan.

Terima kasih telah memilih TextWrap! Kami bertujuan untuk memberikan solusi yang mudah untuk memformat teks atau paragraf di beberapa lingkungan.