DEV Community: Zied Ghalleb

How to show diff in Markdown file

Zied Ghalleb — Sun, 11 Feb 2024 14:40:04 +0000

In software development, accurately communicating code changes is crucial for collaboration. Markdown is a lightweight markup language widely used for documentation, including README files.
One powerful feature of Markdown is its ability to display code differences using the diff syntax.

🔄 What is Markdown diff ?
Markdown diff is a syntax used to represent the difference between two pieces of code by highlighting additions, deletions within the code, making it easier for software engineers to see the changes.

✨ How to Use Markdown diff ?
Very simple

Identify changes: Determine the changes you want to showcase.
Format changes: Use the diff syntax to format your code differences.
Prefix the line: Use a minus sign (-) to indicate deletions and a plus sign (+) to indicate additions.

Join me on this learning journey for more software engineering tips and tricks 🙌 🚀

Dependencies in the JavaScript ecosystem

Zied Ghalleb — Sun, 14 Jan 2024 18:22:48 +0000

What do dependencies mean in the JavaScript ecosystem, what are their types, and how do you choose between them?

What are Dependencies in JS:

Dependencies are simply external pieces of code or libraries that your project relies on to function properly.

Types of Dependencies:

1- Dependencies:
These are the regular dependencies that your project needs to run
(ex: React)

2- Development Dependencies (devDependencies):
These are the dependencies which only needed during development and testing but not while running your code
(ex: jest, babel, eslint...)

3- Peer Dependencies (peerDependencies):
These are the dependencies that you provide when you publish your project.
It helps you letting other consumers of your project know that they need to install the same exact dependency your project expect to work correctly.
It also helps preventing version conflicts.
(ex: React is a peer dependency for React DOM)

4- Optional Dependencies (optionalDependencies):
These are the dependencies that are not crucial for the project to work
If they fail to install, the main project can still function
(ex: extra features that enhance the user experience but are not mandatory)

5- Bundle Dependencies (bundleDependencies):
These are the dependencies that are bundled with your project when it is published.
It ensures specific versions are used, regardless of what might be installed in the consumer's environment. It's useful when you want to control the versions of certain dependencies that are critical for your project.

6- Peer Dependencies Meta (peerDependenciesMeta):
These are the metadata dependencies which serves to provide npm more information on how your peer dependencies are to be used.
It also helps to resolve conflicting peer dependencies more effectively.

How to choose Dependencies:

🎯 Identify specific functionalities required for your project.
🚀 Choose dependencies that scale with your project size.
📚 Evaluate well-documented dependencies for ease of use.
🌐 Opt for dependencies with an active and supportive community.
🤝 Opt for packages that promote collaboration and integration.
🔄 Prefer dependencies regularly updated to ensure compatibility.
🛠️ Select dependencies offering features aligned with your project goals.
🔐 Prioritize dependencies with a good security track record.
💼 Choose dependencies likely to be maintained for the long term.
🧐 Only use dependencies when there is a clear need. Avoid unnecessary dependencies to keep your project lightweight and maintainable.

Conclusion

Understanding what are dependencies, its types and making informed choices ensures that your project is efficient, scalable and meets its functional requirements.

Join me on this learning journey as I simplify the intricacies of software engineering!
🚀 Let's grow together and become better software engineers 🙌
Ready to level up your skills? 🌐 💻

What is Semantic Versioning and why you should use it for your software ?

Zied Ghalleb — Sun, 07 Jan 2024 14:56:00 +0000

Introduction

Have you ever wonder why software have those strange numbers attached to them like 1.0.0 ? Well, that's how we use versioning.

Let's break these numbers down:

🎉 Major version (left side number): When you have a version changed from 1.0.0 to 2.0.0, this means there is an incompatible change or breaking change.
🔧 Minor version (middle number): When you have a version changed from 1.0.0 to 1.1.0, this means there is a new feature backward compatible.
🩹 Patch version (right side number): When you have a version changed from 1.0.0 to 1.0.1, this means there is a fix to a tiny bug or issue.

Why it's essential:

🌪️ It helps avoid chaos by giving you a clear way to track changes and upgrade
🤝 It helps everyone on the team be on the same page
🐛 It helps teams fix issues and glitches without creating a whole new app
🌟 It helps showing new cool features
⏰ It helps going back to older versions if something goes wrong with last change

In conclusion, versioning is a crucial aspect of software development, ensuring order, collaboration and efficient management of code evolution.

For a more detailed and comprehensive guide on semantic versioning, visit https://semver.org