UNPKG

fig-folder

Version:

A CLI tool to organize configuration files into a fig/ folder with safe mode option

96 lines (76 loc) • 4.46 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# 🍑 Fig ``` ███ ██ ███████ ██ ███ █████ █████ ██ ██ ██████ ██ ██ ███ ████ ███ ██ ███ ██ ███ ███ ███ ███ ███ ██ ███ █████ ███ ███ ██ █ ██ ███ ███ ██ ██ █ ██ ███ ███ █ █ ██ ███ ███ ██ ███ ██ ██ ██ ██ ██ ███ ██ ███ ██ ██ ███ ██ ███ ███ ██ ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ █ ██ ██ ██ ██ ██ ██ ███ ███ ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ ██ ██ ██ ██ ██ ███ ██ ██ ████ ████ ████ ██ ██ ██ ███ ████████ ████████ ███ ███ ██ ██████ ████ ████████ █████████████ ██████ ███████████ ████████████ ``` ## What is Fig? Fig is a command-line tool that organizes your project's configuration files into a neat `fig/` directory. It automatically categorizes and moves common configuration files like: - **Linting**: ESLint configs - **Formatting**: Prettier configs - **TypeScript**: tsconfig files - **Build Tools**: Next.js, Vite, Webpack, Tailwind configs - **Environment**: .env files - **Package Managers**: lock files - **Git**: .gitignore, .gitattributes - **Editor**: .editorconfig, VS Code settings - **Testing**: Jest, Vitest, Cypress configs - **Documentation**: README, LICENSE, etc. ## Usage ```bash npm run fig ``` ### Safe Mode (Zero Risk) For completely safe organization that never moves or modifies your original files: ```bash npm run fig -- --safe ``` This mode: - ✅ **Never moves files** - originals stay in place - ✅ **Never creates symlinks** - no permission issues - ✅ **Zero risk of breaking imports** - nothing changes in your project - ✅ **Pure organization** - just copies files to fig/ for viewing ## Features - 🎨 Beautiful ASCII art display - 📁 Automatic file categorization - 📝 Generates organized README - 🎯 Smart file detection - ✨ Colored terminal output ## How it works 1. Scans your project root for configuration files 2. Creates a `fig/` directory if it doesn't exist 3. Moves files into the `fig/` directory 4. Generates a categorized README.txt listing all moved files 5. Displays a beautiful summary with colored output ## Categories When you run `npm run fig`, your configuration files will be organized into these categories: - **Linting** - Code quality and style enforcement - **Formatting** - Code formatting rules - **TypeScript** - TypeScript configuration - **Build Tools** - Build and bundling configuration - **Environment** - Environment variables and settings - **Package Managers** - Dependency lock files - **Git** - Version control configuration - **Editor** - Editor-specific settings - **Testing** - Test framework configuration - **Documentation** - Project documentation files Enjoy your Figs! 🍑