SurviveJS - Maintenance
SurviveJS - Maintenance
Streamline JavaScript Workflow
About the Book
SurviveJS - Maintenance is meant for anyone who has to develop and maintain JavaScript applications or packages.
The purpose of this book is to gather development practices that are particularly useful for anyone who has to maintain JavaScript code or code that compiles to JavaScript.
I, Juho Vepsäläinen, and my co-author Artem Sapegin, have spent years developing npm packages and JavaScript projects. As a result we have gained insight on how to do it and how not to do it. The book combines our experience into a concise format that allows you to improve your development experience.
What Will You Learn
Unless you work on fresh greenfield projects all the time, maintenance concerns are something that will come up fast. The book has been structured into small parts where you learn:
- How to manage npm packages
- How to improve code quality
- How to set up infrastructure for your project
- How to document the project in a sustainable manner
- How to plan for the future
In addition, there are small appendices that delve into deeper detail on topics such as monorepos and customizing ESLint.
Bundles that include this book
Table of Contents
-
- Preface
-
Introduction
- What Will You Learn
- How Is the Book Organized
- Who Is the Book For
- Book Versioning
- Getting Support
- Additional Material
- Acknowledgments
-
I Packaging
-
1. Where to Start Packaging
- 1.1 To Consume Packages or to Develop Them
- 1.2 Use an Existing Package
- 1.3 Enhance an Existing Package
- 1.4 Take Over an Existing Package
- 1.5 Fork an Existing Package
- 1.6 Develop Your Own Package
- 1.7 Consumption Workflow
- 1.8 Using Private Packages
- 1.9 Understanding npm Lookup
- 1.10 Conclusion
-
2. Anatomy of a Package
- 2.1 Understanding package.json
- 2.2 What Files to Publish
- 2.3 Conclusion
-
3. Publishing Packages
- 3.1 Understanding SemVer
- 3.2 Increasing a Version
- 3.3 Publishing a Pre-Release Version
- 3.4 Deprecating, Unpublishing, and Renaming Packages
- 3.5 Sharing Authorship
- 3.6 Conclusion
-
4. Building Packages
- 4.1 Communicating Where Code Should Work
- 4.2 Compiling to Support Specific Environments
-
4.3 Generating a Build on
postinstall
- 4.4 Configuring Babel for Tree Shaking
- 4.5 Using Other Languages Than JavaScript
- 4.6 Cross-Platform Concerns
- 4.7 Conclusion
-
5. Standalone Builds
- 5.1 How Bundlers Work
- 5.2 Universal Module Definition (UMD)
- 5.3 Generating a Bundle Using Microbundle
- 5.4 Conclusion
-
6. Managing Dependencies
- 6.1 Types of Dependencies
- 6.2 Keeping Dependencies Updated
- 6.3 Understanding Version Ranges
- 6.4 Locking Versions
- 6.5 Conclusion
-
1. Where to Start Packaging
-
II Code Quality
-
7. Linting
- 7.1 Why to Lint
- 7.2 Linting JavaScript With ESLint
- 7.3 Linting TypeScript With TSLint
- 7.4 Linting CSS With Stylelint
- 7.5 Conclusion
-
8. Code Formatting
- 8.1 Achieving Code Consistency
- 8.2 Configuring IDEs and Editors With EditorConfig
- 8.3 Formatting Code With Prettier
- 8.4 Formatting CSS With Stylelint
- 8.5 Conclusion
-
9. Typing
- 9.1 The Value of Typing
- 9.2 Flow
- 9.3 TypeScript
- 9.4 The Benefits of Flow and TypeScript
- 9.5 Type Definitions
- 9.6 Challenges of Typing
- 9.7 Conclusion
-
10. Testing
- 10.1 What to Verify With Testing
- 10.2 Develop the Right System the Right Way
- 10.3 How Much to Test
- 10.4 How to Test Old Projects Without Tests
- 10.5 Types of Testing
- 10.6 Conclusion
-
7. Linting
-
III Infrastructure
-
11. Processes
- 11.1 How to Track Issues
- 11.2 How to Manage Pull Requests
- 11.3 How to Design a Development Process
- 11.4 How to Support Users
- 11.5 Conclusion
-
12. Continuous Integration
- 12.1 Setting up Travis CI
- 12.2 Conclusion
-
13. Automation
- 13.1 Git Commit Messages
- 13.2 Semantic Release
- 13.3 Git Hooks
- 13.4 Automating Linting With lint-staged
- 13.5 Automating Releases
- 13.6 gh-lint
- 13.7 Danger
- 13.8 Configuration Automation
- 13.9 Bots
- 13.10 Conclusion
-
11. Processes
-
IV Documentation
-
14. README
- 14.1 What a README Should Contain
- 14.2 Automating README
- 14.3 Testing Examples
- 14.4 Conclusion
-
15. Change Logs
- 15.1 Why Not Commit Log
- 15.2 What Is a Good Change Log
- 15.3 Conclusion
-
16. Site
- 16.1 How to Set up a Site
- 16.2 Interactive Examples and Demos
- 16.3 Hosting
- 16.4 Deployment
- 16.5 Domain Names
- 16.6 Search
- 16.7 Comments
- 16.8 Testing
- 16.9 Conclusion
-
17. API Documentation
- 17.1 Documenting APIs in Code
- 17.2 Generating Documentation
-
18. Other Types of Documentation
- 18.1 Contribution Guidelines
- 18.2 Code of Conduct
- 18.3 Issue and Pull Request Templates
-
19. Linting and Formatting
- 19.1 Linting Markdown With Textlint and Proselint
- 19.2 Formatting Markdown With Prettier
- 19.3 Conclusion
-
14. README
-
V Future
-
20. Longevity
- 20.1 Who Is Going to Develop the Project
- 20.2 Who Is Going to Pay for the Development
- 20.3 Who Is Going to Make Sure the Project Stays on Track
- 20.4 What Happens If Developers Disappear From the Project
- 20.5 How to Attract People to the Project
- 20.6 How to Keep Track of Everything
- 20.7 How to Maintain a Popular Project
- 20.8 Conclusion
-
21. Marketing
- 21.1 Marketing Approaches
- 21.2 Technical Marketing
- 21.3 Content Marketing
- 21.4 Word of Mouth
- 21.5 Conclusion
-
20. Longevity
-
Appendices
-
Managing Packages Using a Monorepo
- Monorepos - What Are They
- Managing Separate Repositories
- Conclusion
-
Customizing ESLint
- Speeding up ESLint Execution
- Skipping ESLint Rules
- Setting Environment
- Writing ESLint Plugins
- ESLint Resources
- Conclusion
-
Managing Packages Using a Monorepo
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$11,815,072writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
Stratospheric
Tom Hombergs, Björn Wilmsmann, and Philip RiecksFrom Zero to Production with Spring Boot and AWS. All you need to know to get a Spring Boot application into production with AWS. No previous AWS knowledge required.
Go to stratospheric.dev for a tour of the contents.
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
node-opcua by example
Etienne RossignonGet the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.
Advanced Web Application Architecture
Matthias NobackThe missing manual for making your web applications future-proof
Jetpack Compose internals
Jorge CastilloJetpack Compose is the future of Android UI. Master how it works internally and become a more efficient developer with it. You'll also find it valuable if you are not an Android dev. This book provides all the details to understand how the Compose compiler & runtime work, and how to create a client library using them.
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
Maîtriser Apache JMeter
Philippe Mouawad, Bruno Demion (Milamber), and Antonio Gomes RodriguesToute la puissance d'Apache JMeter expliquée par ses commiteurs et utilisateurs experts. De l'intégration continue en passant par le Cloud, vous découvrirez comment intégrer JMeter à vos processus "Agile" et Devops.
If you're looking for the newer english version of this book, go to Master JMeter : From load testing to DevOps
D3 Start to Finish
Peter CookD3 Start to Finish shows you how to build a custom, interactive and beautiful data visualisation using the JavaScript library D3.js (versions 6 & 7).
The book covers D3.js concepts such as selections, joins, requests, scale functions, events & transitions. You'll put these concepts into practice by building a custom, interactive data visualisation.
Top Bundles
- #1
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #2
Software Architecture
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #4
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #7
Retromat eBook Bundle for Agile Retrospectives
2 Books
If you facilitate retrospectives this bundle is for you: "Plans for Retrospectives" helps beginners learn the lay of the land with tried-and-true plans. Once you know your way around, "Run great agile retrospectives" contains all 135+ activities in Retromat for you to mix and match. - #8
Static Analysis and Automated Refactoring
2 Books
As PHP developers we are living in the "Age of Static Analysis". We can use a tool like PHPStan to learn about potential bugs before we ship our code to production, and we can enforce our team's programming standards using custom PHPStan rules. Recipes for Decoupling by Matthias Noback teaches you in great detail how to do this, while also... - #10
Practical FP in Scala + Functional event-driven architecture
2 Books
Practical FP in Scala (A hands-on approach) & Functional event-driven architecture, aka FEDA, (Powered by Scala 3), together as a bundle! The content of PFP in Scala is a requirement to understand FEDA so why not take advantage of this bundle!?