Create a tarball from a package
📦 Node.js-> Command Line
✨ The Prompt Phrase
npm pack
💻 Code Preview
📦 All-in-One Code
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Create a tarball from a package - Interactive Tutorial</title>
<link href="https://fonts.googleapis.com/css2?family=Poppins:wght@300;400;600;700;900&family=Fira+Code:wght@400;500;600&display=swap" rel="stylesheet">
<style>
:root {
--bg-primary: #0a0e27;
--bg-secondary: #151932;
--bg-card: #1e2139;
--accent-purple: #a855f7;
--accent-blue: #3b82f6;
--accent-green: #10b981;
--accent-red: #ef4444;
--accent-yellow: #f59e0b;
--accent-pink: #ec4899;
--accent-cyan: #06b6d4;
--accent-orange: #fb923c;
--text-primary: #f8fafc;
--text-secondary: #94a3b8;
--gradient-pack: linear-gradient(135deg, #fb923c 0%, #f59e0b 100%);
--gradient-box: linear-gradient(135deg, #f59e0b 0%, #fbbf24 100%);
--shadow: 0 20px 60px rgba(0, 0, 0, 0.3);
}
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: 'Poppins', sans-serif;
background: var(--bg-primary);
color: var(--text-primary);
line-height: 1.6;
overflow-x: hidden;
}
.container {
max-width: 1200px;
margin: 0 auto;
padding: 20px;
}
.progress-container {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 5px;
background: var(--bg-secondary);
z-index: 1000;
}
.progress-bar {
height: 100%;
background: var(--gradient-pack);
width: 0%;
transition: width 0.3s ease;
}
.hero {
text-align: center;
padding: 100px 20px;
background: var(--gradient-pack);
position: relative;
overflow: hidden;
border-radius: 0 0 50px 50px;
}
.hero::before {
content: '';
position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
background: url('data:image/svg+xml,<svg width="100" height="100" xmlns="http://www.w3.org/2000/svg"><circle cx="50" cy="50" r="2" fill="white" opacity="0.1"/></svg>');
animation: float 20s linear infinite;
}
@keyframes float {
from { transform: translateY(0); }
to { transform: translateY(-100px); }
}
.hero-content {
position: relative;
z-index: 1;
}
.box-icon {
font-size: 5rem;
margin-bottom: 20px;
animation: boxBounce 3s ease-in-out infinite;
}
@keyframes boxBounce {
0%, 100% { transform: translateY(0) rotate(0deg); }
25% { transform: translateY(-20px) rotate(-5deg); }
75% { transform: translateY(-20px) rotate(5deg); }
}
.command-display {
display: inline-block;
background: rgba(0, 0, 0, 0.4);
padding: 25px 40px;
border-radius: 15px;
font-family: 'Fira Code', monospace;
font-size: 1.5rem;
margin: 30px 0;
border: 3px solid rgba(255, 255, 255, 0.3);
animation: pulse 2s ease-in-out infinite;
color: white;
font-weight: 600;
}
@keyframes pulse {
0%, 100% { transform: scale(1); }
50% { transform: scale(1.05); }
}
.hero h1 {
font-size: 3.5rem;
font-weight: 900;
margin-bottom: 20px;
color: white;
text-shadow: 2px 2px 4px rgba(0,0,0,0.3);
}
.hero p {
font-size: 1.4rem;
opacity: 0.95;
color: white;
}
.section {
margin: 60px 0;
}
.section-title {
font-size: 2.5rem;
margin-bottom: 30px;
background: var(--gradient-pack);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
display: inline-block;
font-weight: 700;
}
.card {
background: var(--bg-card);
border-radius: 20px;
padding: 40px;
margin: 30px 0;
box-shadow: var(--shadow);
border: 1px solid rgba(255, 255, 255, 0.05);
transition: transform 0.3s ease;
}
.card:hover {
transform: translateY(-5px);
}
.code-block {
background: #1e1e1e;
border-radius: 15px;
padding: 25px;
margin: 20px 0;
font-family: 'Fira Code', monospace;
position: relative;
}
.code-header {
display: flex;
justify-content: space-between;
align-items: center;
margin-bottom: 15px;
padding-bottom: 15px;
border-bottom: 1px solid rgba(255, 255, 255, 0.1);
}
.terminal-dots {
display: flex;
gap: 6px;
}
.terminal-dot {
width: 12px;
height: 12px;
border-radius: 50%;
}
.dot-red { background: #ff5f56; }
.dot-yellow { background: #ffbd2e; }
.dot-green { background: #27c93f; }
.copy-btn {
background: var(--accent-purple);
color: white;
border: none;
padding: 8px 16px;
border-radius: 8px;
cursor: pointer;
font-size: 0.9rem;
transition: all 0.3s ease;
}
.copy-btn:hover {
background: var(--accent-blue);
transform: scale(1.05);
}
.copy-btn.copied {
background: var(--accent-green);
}
pre {
margin: 0;
overflow-x: auto;
}
code {
color: #e0e0e0;
font-size: 0.95rem;
line-height: 1.8;
}
.code-comment { color: #6a9955; }
.code-string { color: #ce9178; }
.code-keyword { color: #569cd6; }
.code-npm { color: #cb3837; font-weight: 600; }
.code-pack { color: #fb923c; font-weight: 600; }
.steps {
counter-reset: step-counter;
}
.step {
background: var(--bg-secondary);
border-radius: 15px;
padding: 30px;
margin: 20px 0;
position: relative;
padding-left: 100px;
transition: all 0.3s ease;
}
.step:hover {
background: var(--bg-card);
transform: translateX(10px);
}
.step::before {
counter-increment: step-counter;
content: counter(step-counter);
position: absolute;
left: 20px;
top: 50%;
transform: translateY(-50%);
width: 60px;
height: 60px;
background: var(--gradient-pack);
border-radius: 50%;
display: flex;
align-items: center;
justify-content: center;
font-size: 1.8rem;
font-weight: 900;
color: white;
}
.step h3 {
color: var(--accent-orange);
margin-bottom: 10px;
font-size: 1.5rem;
}
.feature-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
gap: 25px;
margin: 30px 0;
}
.feature-card {
background: var(--bg-secondary);
padding: 30px;
border-radius: 15px;
text-align: center;
transition: all 0.3s ease;
border: 2px solid transparent;
}
.feature-card:hover {
border-color: var(--accent-orange);
transform: translateY(-10px);
}
.feature-icon {
font-size: 3.5rem;
margin-bottom: 15px;
}
.feature-title {
font-weight: 600;
color: var(--accent-orange);
margin-bottom: 10px;
font-size: 1.3rem;
}
.demo-container {
background: var(--bg-secondary);
border-radius: 20px;
padding: 40px;
margin: 30px 0;
}
.file-display {
background: var(--bg-card);
border-radius: 15px;
padding: 25px;
margin: 20px 0;
border: 2px solid var(--accent-orange);
}
.file-item {
display: flex;
align-items: center;
gap: 10px;
padding: 10px;
margin: 5px 0;
background: var(--bg-secondary);
border-radius: 8px;
}
.terminal {
background: #1e1e1e;
border-radius: 15px;
padding: 20px;
font-family: 'Fira Code', monospace;
min-height: 250px;
margin: 20px 0;
overflow-y: auto;
max-height: 500px;
}
.terminal-line {
margin: 10px 0;
}
.terminal-prompt {
color: var(--accent-green);
}
.demo-button {
background: var(--gradient-pack);
color: white;
border: none;
padding: 15px 40px;
border-radius: 50px;
font-size: 1.1rem;
font-weight: 600;
cursor: pointer;
transition: all 0.3s ease;
display: inline-flex;
align-items: center;
gap: 10px;
margin: 10px;
}
.demo-button:hover {
transform: scale(1.05);
box-shadow: 0 10px 30px rgba(251, 146, 60, 0.4);
}
.tabs {
display: flex;
gap: 10px;
margin-bottom: 20px;
flex-wrap: wrap;
}
.tab {
padding: 12px 24px;
background: var(--bg-secondary);
border: none;
border-radius: 10px;
color: var(--text-primary);
cursor: pointer;
transition: all 0.3s ease;
font-size: 1rem;
}
.tab:hover {
background: var(--bg-card);
}
.tab.active {
background: var(--gradient-pack);
color: white;
}
.tab-content {
display: none;
}
.tab-content.active {
display: block;
}
.accordion-header {
cursor: pointer;
display: flex;
justify-content: space-between;
align-items: center;
padding: 20px;
background: var(--bg-secondary);
border-radius: 12px;
margin: 15px 0;
transition: all 0.3s ease;
}
.accordion-header:hover {
background: var(--bg-card);
}
.accordion-icon {
transition: transform 0.3s ease;
font-size: 1.2rem;
}
.accordion-icon.active {
transform: rotate(180deg);
}
.accordion-content {
max-height: 0;
overflow: hidden;
transition: max-height 0.3s ease;
}
.accordion-content.active {
max-height: 2000px;
}
.accordion-body {
padding: 20px;
background: var(--bg-secondary);
border-radius: 12px;
margin-top: 5px;
}
.tip, .warning, .success, .info {
padding: 20px;
border-radius: 10px;
margin: 20px 0;
}
.tip {
background: rgba(59, 130, 246, 0.1);
border-left: 4px solid var(--accent-blue);
}
.tip::before { content: '💡 '; font-size: 1.5rem; }
.warning {
background: rgba(239, 68, 68, 0.1);
border-left: 4px solid var(--accent-red);
}
.warning::before { content: '⚠️ '; font-size: 1.5rem; }
.success {
background: rgba(16, 185, 129, 0.1);
border-left: 4px solid var(--accent-green);
}
.success::before { content: '✅ '; font-size: 1.5rem; }
.info {
background: rgba(236, 72, 153, 0.1);
border-left: 4px solid var(--accent-pink);
}
.info::before { content: '🔍 '; font-size: 1.5rem; }
.quiz-container {
background: var(--bg-card);
border-radius: 20px;
padding: 40px;
margin: 30px 0;
}
.quiz-question {
margin: 30px 0;
}
.quiz-question h3 {
color: var(--accent-purple);
margin-bottom: 20px;
font-size: 1.3rem;
}
.quiz-options {
display: flex;
flex-direction: column;
gap: 15px;
}
.quiz-option {
background: var(--bg-secondary);
padding: 20px;
border-radius: 12px;
cursor: pointer;
transition: all 0.3s ease;
border: 2px solid transparent;
}
.quiz-option:hover {
border-color: var(--accent-blue);
transform: translateX(10px);
}
.quiz-option.correct {
border-color: var(--accent-green);
background: rgba(16, 185, 129, 0.1);
}
.quiz-option.incorrect {
border-color: var(--accent-red);
background: rgba(239, 68, 68, 0.1);
}
.quiz-feedback {
margin-top: 15px;
padding: 15px;
border-radius: 10px;
display: none;
}
.quiz-feedback.show {
display: block;
}
.quiz-feedback.correct {
background: rgba(16, 185, 129, 0.1);
border-left: 4px solid var(--accent-green);
}
.quiz-feedback.incorrect {
background: rgba(239, 68, 68, 0.1);
border-left: 4px solid var(--accent-red);
}
.cheat-sheet {
background: var(--gradient-pack);
border-radius: 20px;
padding: 40px;
margin: 30px 0;
color: white;
}
.cheat-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
gap: 20px;
margin-top: 30px;
}
.cheat-item {
background: rgba(255, 255, 255, 0.15);
backdrop-filter: blur(10px);
padding: 20px;
border-radius: 15px;
border: 1px solid rgba(255, 255, 255, 0.2);
}
.cheat-item h4 {
color: white;
margin-bottom: 10px;
font-weight: 600;
}
.cheat-item code {
background: rgba(0, 0, 0, 0.3);
padding: 4px 8px;
border-radius: 5px;
font-size: 0.9rem;
color: white;
}
.highlight {
color: var(--accent-yellow);
font-weight: 600;
}
.footer {
text-align: center;
padding: 40px 20px;
background: var(--bg-secondary);
margin-top: 80px;
border-radius: 20px;
}
.footer p {
color: var(--text-secondary);
margin: 10px 0;
}
.badge {
display: inline-block;
padding: 6px 12px;
background: var(--gradient-pack);
border-radius: 20px;
font-size: 0.85rem;
font-weight: 600;
margin: 5px;
}
.confetti {
position: fixed;
width: 10px;
height: 10px;
background: var(--accent-orange);
animation: confetti-fall 3s linear forwards;
z-index: 9999;
}
@keyframes confetti-fall {
to {
transform: translateY(100vh) rotate(360deg);
opacity: 0;
}
}
@media (max-width: 768px) {
.hero h1 { font-size: 2rem; }
.command-display { font-size: 1rem; padding: 15px 20px; }
.section-title { font-size: 1.8rem; }
.card { padding: 25px; }
.step { padding-left: 80px; }
.step::before { width: 50px; height: 50px; font-size: 1.5rem; }
}
</style>
</head>
<body>
<div class="progress-container">
<div class="progress-bar" id="progressBar"></div>
</div>
<div class="hero">
<div class="hero-content">
<div class="box-icon">📦</div>
<h1>Master npm pack!</h1>
<div class="command-display">npm pack</div>
<p>Create shareable package tarballs! 🎁</p>
</div>
</div>
<div class="container">
<!-- What Is It -->
<section class="section">
<h2 class="section-title">🤔 What Is npm pack?</h2>
<div class="card">
<p style="font-size: 1.2rem; margin-bottom: 20px;">
<code>npm pack</code> creates a <span class="highlight">.tgz tarball file</span> from your package - basically a compressed archive of your project that can be shared, tested, or published! 📦
</p>
<p style="margin-bottom: 20px;">
Think of it like vacuum-sealing food! 🍱 You take your package (all the files npm would publish), compress them into a single .tgz file, and now you can share it, test it locally, or inspect exactly what would be published to npm - without actually publishing!
</p>
<div class="info">
<strong>Breaking It Down:</strong>
<ul style="margin-left: 30px; margin-top: 10px; line-height: 2;">
<li><code class="code-npm">npm</code> - Node Package Manager</li>
<li><code class="code-pack">pack</code> - Package into tarball</li>
<li>Creates a <code>.tgz</code> file (compressed archive)</li>
<li>Contains only files that would be published</li>
<li>Perfect for testing before publishing</li>
</ul>
</div>
<div style="margin-top: 30px;">
<h3 style="color: var(--accent-pink); margin-bottom: 15px;">What's a Tarball? 🔍</h3>
<p>A tarball (.tgz or .tar.gz) is a compressed archive file - like a .zip but commonly used in Unix/Linux systems. It bundles all your package files into one portable file that can be easily shared or installed!</p>
</div>
</div>
</section>
<!-- Output Example -->
<section class="section">
<h2 class="section-title">📊 What Gets Packed?</h2>
<div class="card">
<h3 style="margin-bottom: 20px; text-align: center;">See What's Inside! 🎯</h3>
<div class="file-display">
<h4 style="color: var(--accent-green); margin-bottom: 15px;">✅ Included Files:</h4>
<div class="file-item">
<span>📄</span>
<span>package.json (always)</span>
</div>
<div class="file-item">
<span>📝</span>
<span>README.md</span>
</div>
<div class="file-item">
<span>📜</span>
<span>LICENSE</span>
</div>
<div class="file-item">
<span>📁</span>
<span>src/ (your source code)</span>
</div>
<div class="file-item">
<span>📁</span>
<span>lib/ or dist/ (built files)</span>
</div>
</div>
<div class="file-display" style="margin-top: 20px;">
<h4 style="color: var(--accent-red); margin-bottom: 15px;">❌ Excluded Files:</h4>
<div class="file-item">
<span>🚫</span>
<span>node_modules/ (always excluded)</span>
</div>
<div class="file-item">
<span>🚫</span>
<span>.git/ (version control)</span>
</div>
<div class="file-item">
<span>🚫</span>
<span>.env (environment variables)</span>
</div>
<div class="file-item">
<span>🚫</span>
<span>Files in .npmignore</span>
</div>
</div>
</div>
</section>
<!-- Why Use It -->
<section class="section">
<h2 class="section-title">✨ Why Use npm pack?</h2>
<div class="card">
<div class="feature-grid">
<div class="feature-card">
<div class="feature-icon">🔍</div>
<div class="feature-title">Preview Publishing</div>
<p style="color: var(--text-secondary);">See what gets published!</p>
</div>
<div class="feature-card">
<div class="feature-icon">🧪</div>
<div class="feature-title">Local Testing</div>
<p style="color: var(--text-secondary);">Test before publishing!</p>
</div>
<div class="feature-card">
<div class="feature-icon">📤</div>
<div class="feature-title">Share Privately</div>
<p style="color: var(--text-secondary);">Send to teammates!</p>
</div>
<div class="feature-card">
<div class="feature-icon">💾</div>
<div class="feature-title">Offline Install</div>
<p style="color: var(--text-secondary);">No internet needed!</p>
</div>
<div class="feature-card">
<div class="feature-icon">🎯</div>
<div class="feature-title">Exact Bundle</div>
<p style="color: var(--text-secondary);">What users get!</p>
</div>
<div class="feature-card">
<div class="feature-icon">🛡️</div>
<div class="feature-title">Safe Testing</div>
<p style="color: var(--text-secondary);">No accidental publish!</p>
</div>
</div>
</div>
</section>
<!-- How It Works -->
<section class="section">
<h2 class="section-title">⚙️ How Does It Work?</h2>
<div class="card">
<div class="steps">
<div class="step">
<h3>Step 1: Read package.json</h3>
<p>npm reads your package name and version.</p>
</div>
<div class="step">
<h3>Step 2: Collect Files</h3>
<p>Gathers all files that would be published (respects .npmignore).</p>
</div>
<div class="step">
<h3>Step 3: Run Prepare Scripts</h3>
<p>Executes "prepare" script if defined (build step).</p>
</div>
<div class="step">
<h3>Step 4: Create Archive</h3>
<p>Compresses files into .tgz format.</p>
</div>
<div class="step">
<h3>Step 5: Name File</h3>
<p>Creates: packagename-version.tgz</p>
</div>
<div class="step">
<h3>Step 6: Done!</h3>
<p>Tarball ready to share or test! 🎉</p>
</div>
</div>
</div>
</section>
<!-- Live Demo -->
<section class="section">
<h2 class="section-title">🎮 Interactive Demo</h2>
<div class="demo-container">
<div style="margin-bottom: 30px; text-align: center;">
<h4 style="margin-bottom: 15px;">See npm pack in Action! 📦</h4>
<button class="demo-button" onclick="simulatePack()">
<span>📦</span>
<span>Run npm pack</span>
</button>
<button class="demo-button" onclick="simulateInstall()">
<span>📥</span>
<span>Install from Tarball</span>
</button>
<button class="demo-button" onclick="simulateInspect()">
<span>🔍</span>
<span>Inspect Contents</span>
</button>
</div>
<div class="terminal" id="terminal">
<div class="terminal-line">
<span class="terminal-prompt">$</span>
<span style="color: var(--text-secondary);"> Ready to pack your package...</span>
</div>
</div>
</div>
</section>
<!-- Code Breakdown -->
<section class="section">
<h2 class="section-title">💻 Usage Examples</h2>
<div class="card">
<div class="tabs">
<button class="tab active" onclick="switchTab('basic')">Basic Usage</button>
<button class="tab" onclick="switchTab('testing')">Local Testing</button>
<button class="tab" onclick="switchTab('sharing')">Sharing</button>
<button class="tab" onclick="switchTab('advanced')">Advanced</button>
</div>
<div id="basic" class="tab-content active">
<h3 style="color: var(--accent-pink); margin-bottom: 15px;">Basic Usage</h3>
<div class="code-block">
<div class="code-header">
<div class="terminal-dots">
<div class="terminal-dot dot-red"></div>
<div class="terminal-dot dot-yellow"></div>
<div class="terminal-dot dot-green"></div>
</div>
<button class="copy-btn" onclick="copyCode('basic-code')">📋 Copy</button>
</div>
<pre><code id="basic-code"><span class="code-comment"># Create tarball from current package</span>
npm pack
<span class="code-comment"># Output: my-package-1.0.0.tgz</span>
<span class="code-comment"># Pack a specific package</span>
npm pack lodash
<span class="code-comment"># Pack from a folder</span>
npm pack ./my-package
<span class="code-comment"># Pack and specify output directory</span>
npm pack --pack-destination=./dist
<span class="code-comment"># What gets created:</span>
<span class="code-comment"># - A .tgz file named: packagename-version.tgz</span>
<span class="code-comment"># - Contains all files that would be published</span></code></pre>
</div>
<div class="success" style="margin-top: 15px;">
<strong>Result:</strong> Tarball created in current directory!
</div>
</div>
<div id="testing" class="tab-content">
<h3 style="color: var(--accent-pink); margin-bottom: 15px;">Local Testing Workflow</h3>
<div class="code-block">
<div class="code-header">
<div class="terminal-dots">
<div class="terminal-dot dot-red"></div>
<div class="terminal-dot dot-yellow"></div>
<div class="terminal-dot dot-green"></div>
</div>
<button class="copy-btn" onclick="copyCode('testing-code')">📋 Copy</button>
</div>
<pre><code id="testing-code"><span class="code-comment"># Step 1: Create tarball from your package</span>
cd my-package
npm pack
<span class="code-comment"># Creates: my-package-1.0.0.tgz</span>
<span class="code-comment"># Step 2: Test in another project</span>
cd ../test-project
npm install ../my-package/my-package-1.0.0.tgz
<span class="code-comment"># Or use relative path directly</span>
npm install ../my-package
<span class="code-comment"># Step 3: Test your package</span>
node -e <span class="code-string">"require('my-package')"</span>
<span class="code-comment"># Step 4: Uninstall when done</span>
npm uninstall my-package
<span class="code-comment"># This workflow lets you test EXACTLY what users will get!</span></code></pre>
</div>
<div class="tip" style="margin-top: 15px;">
<strong>Pro Tip:</strong> Always test with npm pack before publishing!
</div>
</div>
<div id="sharing" class="tab-content">
<h3 style="color: var(--accent-pink); margin-bottom: 15px;">Sharing Packages</h3>
<div class="code-block">
<div class="code-header">
<div class="terminal-dots">
<div class="terminal-dot dot-red"></div>
<div class="terminal-dot dot-yellow"></div>
<div class="terminal-dot dot-green"></div>
</div>
<button class="copy-btn" onclick="copyCode('sharing-code')">📋 Copy</button>
</div>
<pre><code id="sharing-code"><span class="code-comment"># Create tarball</span>
npm pack
<span class="code-comment"># Share via email/Slack/etc</span>
<span class="code-comment"># Send the .tgz file to teammates</span>
<span class="code-comment"># Teammate installs from tarball:</span>
npm install ./my-package-1.0.0.tgz
<span class="code-comment"># Or host on internal server</span>
<span class="code-comment"># Upload to company file server</span>
npm install https://internal.company.com/packages/my-package-1.0.0.tgz
<span class="code-comment"># Use in package.json</span>
{
<span class="code-string">"dependencies"</span>: {
<span class="code-string">"my-package"</span>: <span class="code-string">"file:./packages/my-package-1.0.0.tgz"</span>
}
}
<span class="code-comment"># Perfect for:</span>
<span class="code-comment"># - Private packages (no npm account needed)</span>
<span class="code-comment"># - Beta testing with specific users</span>
<span class="code-comment"># - Offline installations</span></code></pre>
</div>
</div>
<div id="advanced" class="tab-content">
<h3 style="color: var(--accent-pink); margin-bottom: 15px;">Advanced Usage</h3>
<div class="code-block">
<div class="code-header">
<div class="terminal-dots">
<div class="terminal-dot dot-red"></div>
<div class="terminal-dot dot-yellow"></div>
<div class="terminal-dot dot-green"></div>
</div>
<button class="copy-btn" onclick="copyCode('advanced-code')">📋 Copy</button>
</div>
<pre><code id="advanced-code"><span class="code-comment"># Inspect tarball contents without extracting</span>
tar -tzf my-package-1.0.0.tgz
<span class="code-comment"># Extract to see files</span>
tar -xzf my-package-1.0.0.tgz
<span class="code-comment"># Use with .npmignore to control what's packed</span>
<span class="code-comment"># .npmignore file:</span>
test/
*.test.js
.env
.git
<span class="code-comment"># Or use "files" in package.json (whitelist)</span>
{
<span class="code-string">"files"</span>: [
<span class="code-string">"dist/"</span>,
<span class="code-string">"lib/"</span>,
<span class="code-string">"README.md"</span>
]
}
<span class="code-comment"># Pack with dry run (see what would be included)</span>
npm publish --dry-run
<span class="code-comment"># Automate in CI/CD</span>
npm pack --pack-destination=./artifacts
<span class="code-comment"># Use in monorepo</span>
npm pack --workspace=packages/my-package</code></pre>
</div>
</div>
</div>
</section>
<!-- Common Mistakes -->
<section class="section">
<h2 class="section-title">❌ Common Mistakes</h2>
<div class="card">
<div class="accordion">
<div class="accordion-item">
<div class="accordion-header" onclick="toggleAccordion(this)">
<span><strong>1. Not Using .npmignore</strong></span>
<span class="accordion-icon">▼</span>
</div>
<div class="accordion-content">
<div class="accordion-body">
<div class="warning">
<strong>Problem:</strong> Packing test files, .env, and other unnecessary files
</div>
<div class="success" style="margin-top: 15px;">
<strong>Solution:</strong> Create .npmignore or use "files" field in package.json!
</div>
</div>
</div>
</div>
<div class="accordion-item">
<div class="accordion-header" onclick="toggleAccordion(this)">
<span><strong>2. Forgetting to Build</strong></span>
<span class="accordion-icon">▼</span>
</div>
<div class="accordion-content">
<div class="accordion-body">
<div class="warning">
<strong>Problem:</strong> Packing without building TypeScript/bundling
</div>
<div class="success" style="margin-top: 15px;">
<strong>Solution:</strong> Add "prepare" script to package.json to auto-build!
</div>
</div>
</div>
</div>
<div class="accordion-item">
<div class="accordion-header" onclick="toggleAccordion(this)">
<span><strong>3. Not Testing the Tarball</strong></span>
<span class="accordion-icon">▼</span>
</div>
<div class="accordion-content">
<div class="accordion-body">
<div class="warning">
<strong>Problem:</strong> Publishing without testing what users will actually get
</div>
<div class="success" style="margin-top: 15px;">
<strong>Solution:</strong> Always npm pack → install tarball → test before publishing!
</div>
</div>
</div>
</div>
<div class="accordion-item">
<div class="accordion-header" onclick="toggleAccordion(this)">
<span><strong>4. Wrong Main/Exports Field</strong></span>
<span class="accordion-icon">▼</span>
</div>
<div class="accordion-content">
<div class="accordion-body">
<div class="warning">
<strong>Problem:</strong> "main" field points to file not in tarball
</div>
<div class="success" style="margin-top: 15px;">
<strong>Solution:</strong> Extract tarball and verify entry points exist!
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<!-- Pro Tips -->
<section class="section">
<h2 class="section-title">🚀 Pro Tips</h2>
<div class="card">
<div class="tip">
<strong>Test before publish</strong> - Always npm pack and test the tarball locally first!
</div>
<div class="tip">
<strong>Use "files" field</strong> - Whitelist approach is safer than .npmignore blacklist!
</div>
<div class="tip">
<strong>Inspect contents</strong> - Use <code>tar -tzf package.tgz</code> to see what's inside!
</div>
<div class="tip">
<strong>Automate builds</strong> - Add "prepare" script to auto-build before packing!
</div>
<div class="tip">
<strong>Check size</strong> - Large tarballs = slow installs. Keep it lean!
</div>
<div class="tip">
<strong>Version control</strong> - Don't commit .tgz files to git (add to .gitignore)!
</div>
<div class="tip">
<strong>CI/CD integration</strong> - Pack in CI to create release artifacts!
</div>
</div>
</section>
<!-- Quiz -->
<section class="section">
<h2 class="section-title">🎯 Knowledge Check Quiz</h2>
<div class="quiz-container">
<p style="margin-bottom: 30px; font-size: 1.1rem;">Test your understanding! 🧠</p>
<div class="quiz-question">
<h3>Question 1: What does npm pack create?</h3>
<div class="quiz-options">
<div class="quiz-option" onclick="checkAnswer(this, false, 1)">A) A zip file</div>
<div class="quiz-option" onclick="checkAnswer(this, true, 1)">B) A .tgz tarball file</div>
<div class="quiz-option" onclick="checkAnswer(this, false, 1)">C) A folder</div>
</div>
<div class="quiz-feedback" id="feedback1"></div>
</div>
<div class="quiz-question">
<h3>Question 2: What's excluded from the tarball?</h3>
<div class="quiz-options">
<div class="quiz-option" onclick="checkAnswer(this, false, 2)">A) package.json</div>
<div class="quiz-option" onclick="checkAnswer(this, true, 2)">B) node_modules folder</div>
<div class="quiz-option" onclick="checkAnswer(this, false, 2)">C) README.md</div>
</div>
<div class="quiz-feedback" id="feedback2"></div>
</div>
<div class="quiz-question">
<h3>Question 3: When should you use npm pack?</h3>
<div class="quiz-options">
<div class="quiz-option" onclick="checkAnswer(this, false, 3)">A) Only after publishing</div>
<div class="quiz-option" onclick="checkAnswer(this, true, 3)">B) Before publishing to test locally</div>
<div class="quiz-option" onclick="checkAnswer(this, false, 3)">C) Never - it's deprecated</div>
</div>
<div class="quiz-feedback" id="feedback3"></div>
</div>
<div id="quizScore" style="margin-top: 30px; padding: 20px; background: var(--bg-secondary); border-radius: 12px; display: none;">
<h3 style="color: var(--accent-green); font-size: 1.5rem;">🎉 Quiz Complete!</h3>
<p id="scoreText" style="font-size: 1.2rem; margin-top: 10px;"></p>
</div>
</div>
</section>
<!-- Summary Card -->
<section class="section">
<h2 class="section-title">📚 Quick Reference</h2>
<div class="cheat-sheet">
<h3 style="margin-bottom: 20px; font-size: 2rem;">npm pack Cheat Sheet! 🔖</h3>
<div class="cheat-grid">
<div class="cheat-item">
<h4>📦 Command</h4>
<p><code>npm pack</code></p>
<p style="font-size: 0.85rem; margin-top: 5px;">Create tarball</p>
</div>
<div class="cheat-item">
<h4>📄 Output</h4>
<p>packagename-version.tgz</p>
<p style="font-size: 0.85rem; margin-top: 5px;">Compressed archive</p>
</div>
<div class="cheat-item">
<h4>🎯 Purpose</h4>
<p>Test before publish</p>
<p style="font-size: 0.85rem; margin-top: 5px;">Preview bundle</p>
</div>
<div class="cheat-item">
<h4>📥 Install</h4>
<p><code>npm install ./package.tgz</code></p>
<p style="font-size: 0.85rem; margin-top: 5px;">From tarball</p>
</div>
<div class="cheat-item">
<h4>🔍 Inspect</h4>
<p><code>tar -tzf package.tgz</code></p>
<p style="font-size: 0.85rem; margin-top: 5px;">List contents</p>
</div>
<div class="cheat-item">
<h4>🚫 Exclude</h4>
<p>.npmignore or "files"</p>
<p style="font-size: 0.85rem; margin-top: 5px;">Control contents</p>
</div>
<div class="cheat-item">
<h4>✅ Use For</h4>
<p>Testing, sharing, offline</p>
<p style="font-size: 0.85rem; margin-top: 5px;">Before publish</p>
</div>
<div class="cheat-item">
<h4>📍 Location</h4>
<p>Current directory</p>
<p style="font-size: 0.85rem; margin-top: 5px;">Or --pack-destination</p>
</div>
</div>
</div>
</section>
<!-- Footer -->
<div class="footer">
<h2 style="font-size: 2rem; margin-bottom: 20px; color: var(--accent-pink);">🎉 Congratulations!</h2>
<p style="font-size: 1.2rem; margin-bottom: 20px;">You now understand <strong>npm pack</strong>! 🚀</p>
<div style="margin: 30px 0;">
<span class="badge">📦 Package Master</span>
<span class="badge">🎁 Tarball Pro</span>
<span class="badge">🚀 npm Expert</span>
</div>
<p style="color: var(--text-secondary); margin-top: 30px;">Generated by <strong>AI Prompt Dictionary</strong> 🤖</p>
<p style="color: var(--text-secondary); font-size: 0.9rem;">Made with ❤️ for developers learning npm</p>
</div>
</div>
<script>
// Progress bar
window.addEventListener('scroll', () => {
const winScroll = document.body.scrollTop || document.documentElement.scrollTop;
const height = document.documentElement.scrollHeight - document.documentElement.clientHeight;
const scrolled = (winScroll / height) * 100;
document.getElementById('progressBar').style.width = scrolled + '%';
});
// Copy to clipboard
function copyCode(codeId) {
const code = document.getElementById(codeId).innerText;
navigator.clipboard.writeText(code).then(() => {
event.target.textContent = '✅ Copied!';
event.target.classList.add('copied');
setTimeout(() => {
event.target.textContent = '📋 Copy';
event.target.classList.remove('copied');
}, 2000);
});
}
// Tab switching
function switchTab(tabName) {
document.querySelectorAll('.tab-content').forEach(c => c.classList.remove('active'));
document.querySelectorAll('.tab').forEach(t => t.classList.remove('active'));
document.getElementById(tabName).classList.add('active');
event.target.classList.add('active');
}
// Accordion toggle
function toggleAccordion(header) {
const content = header.nextElementSibling;
const icon = header.querySelector('.accordion-icon');
content.classList.toggle('active');
icon.classList.toggle('active');
}
// Simulate npm pack
function simulatePack() {
const terminal = document.getElementById('terminal');
terminal.innerHTML = '<div class="terminal-line"><span class="terminal-prompt">$</span> npm pack</div>';
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 10px;">📦 Packing my-awesome-package...</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-top: 5px;">📋 Reading package.json...</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary);">🔍 Collecting files...</div>';
}, 500);
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-orange); margin-top: 10px;">🏗️ Running prepare script...</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-left: 20px;">✓ Building TypeScript</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-left: 20px;">✓ Bundling assets</div>';
}, 1200);
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px; font-weight: 600;">✅ Created: my-awesome-package-1.0.0.tgz</div>';
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 5px;">📊 Size: 45.2 KB</div>';
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 5px;">📁 Files: 12</div>';
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px;">🎉 Tarball ready to share or test!</div>';
createConfetti();
}, 2000);
}
// Simulate install from tarball
function simulateInstall() {
const terminal = document.getElementById('terminal');
terminal.innerHTML = '<div class="terminal-line"><span class="terminal-prompt">$</span> npm install ./my-awesome-package-1.0.0.tgz</div>';
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 10px;">📥 Installing from tarball...</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-top: 5px;">📦 Extracting package...</div>';
}, 500);
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 10px;">🔗 Linking dependencies...</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-top: 5px;">✓ Installed in node_modules/</div>';
}, 1200);
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px; font-weight: 600;">✅ Successfully installed my-awesome-package@1.0.0</div>';
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 10px;">🧪 Now you can test it:</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-left: 20px;">const pkg = require(\'my-awesome-package\');</div>';
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px;">🎯 Perfect for local testing!</div>';
createConfetti();
}, 2000);
}
// Simulate inspect
function simulateInspect() {
const terminal = document.getElementById('terminal');
terminal.innerHTML = '<div class="terminal-line"><span class="terminal-prompt">$</span> tar -tzf my-awesome-package-1.0.0.tgz</div>';
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 10px;">🔍 Inspecting tarball contents...</div>';
}, 500);
setTimeout(() => {
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px;">📄 package/package.json</div>';
terminal.innerHTML += '<div style="color: var(--accent-green);">📝 package/README.md</div>';
terminal.innerHTML += '<div style="color: var(--accent-green);">📜 package/LICENSE</div>';
terminal.innerHTML += '<div style="color: var(--accent-green);">📁 package/dist/index.js</div>';
terminal.innerHTML += '<div style="color: var(--accent-green);">📁 package/dist/utils.js</div>';
terminal.innerHTML += '<div style="color: var(--accent-green);">📁 package/lib/helper.js</div>';
terminal.innerHTML += '<div style="color: var(--accent-cyan); margin-top: 15px;">✅ All files look good!</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary); margin-top: 5px;">🚫 node_modules/ - correctly excluded</div>';
terminal.innerHTML += '<div style="color: var(--text-secondary);">🚫 test/ - correctly excluded</div>';
terminal.innerHTML += '<div style="color: var(--accent-green); margin-top: 10px;">🎯 This is exactly what users will get!</div>';
createConfetti();
}, 1200);
}
// Quiz system
let quizScore = 0;
let questionsAnswered = 0;
function checkAnswer(element, isCorrect, questionNum) {
const options = element.parentElement.querySelectorAll('.quiz-option');
options.forEach(opt => opt.style.pointerEvents = 'none');
const feedback = document.getElementById('feedback' + questionNum);
if (isCorrect) {
element.classList.add('correct');
feedback.className = 'quiz-feedback correct show';
feedback.innerHTML = '<strong>🎉 Correct!</strong> Great job!';
quizScore++;
createConfetti();
} else {
element.classList.add('incorrect');
feedback.className = 'quiz-feedback incorrect show';
feedback.innerHTML = '<strong>❌ Not quite!</strong> Review the material and try again!';
}
questionsAnswered++;
if (questionsAnswered === 3) {
setTimeout(() => {
document.getElementById('quizScore').style.display = 'block';
document.getElementById('scoreText').textContent = `You scored ${quizScore}/3! ${quizScore === 3 ? '🏆 Perfect!' : quizScore === 2 ? '👍 Good job!' : '💪 Keep learning!'}`;
}, 1000);
}
}
// Confetti animation
function createConfetti() {
const colors = ['#fb923c', '#f59e0b', '#fbbf24', '#10b981', '#3b82f6'];
for (let i = 0; i < 50; i++) {
const confetti = document.createElement('div');
confetti.className = 'confetti';
confetti.style.left = Math.random() * window.innerWidth + 'px';
confetti.style.background = colors[Math.floor(Math.random() * colors.length)];
confetti.style.animationDuration = (2 + Math.random() * 2) + 's';
document.body.appendChild(confetti);
setTimeout(() => confetti.remove(), 4000);
}
}
</script>
</body>
</html>
Live Preview