🎨 @3d-outlet/core

Core utilities and shared configuration for 3D OUTLET projects

✨ Features

• 🎯 Unified Prettier Configuration - Consistent code formatting across all projects
• 📦 Import Sorting - Automatically sorts and organizes imports
• 🔧 TypeScript Support - Full TypeScript configuration support
• 🚀 Zero Config - Works out of the box with sensible defaults
• 💎 Modern Standards - Uses tabs, single quotes, and modern JavaScript conventions

📦 Installation

npm install --save-dev @3d-outlet/core prettier
# or
pnpm add -D @3d-outlet/core prettier
# or
yarn add -D @3d-outlet/core prettier
# or
bun add -d @3d-outlet/core prettier

🚀 Quick Start

Using Prettier Configuration

Create a prettier.config.mjs file in your project root:

import prettierConfig from '@3d-outlet/core/prettier'

export default prettierConfig

Or extend it with your own settings:

import prettierConfig from '@3d-outlet/core/prettier'

export default {
	...prettierConfig,
	// Your custom overrides here
	printWidth: 100
}

⚙️ Configuration

The default configuration includes:

• Tabs: Uses tabs instead of spaces (4-width)
• No Semicolons: Clean, modern JavaScript style
• Single Quotes: Consistent quote style
• Import Sorting: Automatically sorts imports by:
  1. Third-party modules
  2. @/ aliased imports
  3. Relative imports (../)
  4. Local imports (./)

Example

Before formatting:

import { Component } from 'react'
import './styles.css'
import { Button } from '@/components'
import { useState } from 'react'

After formatting:

import { Component, useState } from 'react'

import { Button } from '@/components'

import './styles.css'

📋 Requirements

• Node.js: >= 16.0.0
• Prettier: ^3.0.0

🛠️ Usage in Package.json

Add formatting scripts to your package.json:

{
	"scripts": {
		"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
		"format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\""
	}
}

🎯 Editor Integration

VS Code

Add to your .vscode/settings.json:

{
	"editor.defaultFormatter": "esbenp.prettier-vscode",
	"editor.formatOnSave": true,
	"[javascript]": {
		"editor.defaultFormatter": "esbenp.prettier-vscode"
	},
	"[typescript]": {
		"editor.defaultFormatter": "esbenp.prettier-vscode"
	}
}

📝 License

ISC © TeaCoder & Ilnaz Mingaleev

👨‍💻 Authors

Ilnaz Mingaleev

• Email: [email protected]

TeaCoder (Vadim)

• Email: [email protected]

Made with ❤️ for the 3D OUTLET project (private repo)
Internal use only.