heig-lherman/dai-practical-content

My repo for the practical contents of DAI (23/24) at HEIG-VD

dai-practical-content's Issues

PW01 - Encode command

Implement a command that can encode a file to base64

simplify project structure

It seems the packaged JARs do not work as intended, due to the configuration not being inherited (was an attempt to avoid having to declare the configuration in every module).

There are a couple of things I noticed while investigating:

• The configuration for maven-assembly-plugin should be declared under pluginManagement and the plugin should be referenced in the modules
• The maven-failsafe-plugin is not needed, we probably won't write integration tests.
• The version for maven-surefire-plugin is parametrized, but the property isn't used in pluginManagement

PW01 - Change to text processing

After reading the instructions a couple of times, the fact that we are supposed to give charsets as parameters makes me think we are expected to use the Reader and Writer ecosystem. That is to say, we are expected to process text.

We should therefore refactor the existing base64 project to a text CLI with the ability to apply some transformations on a text file.

For the first iteration, I think we should work on building a copy, uppercase and lowercase commands.

Prepare repo for further practical works by implementing a monorepo structure

I want this repo to be my only repository where I work on practical works. As such, this repository should become a well-managed monorepo with the practical works being on own modules.

Let's start simple by creating a module for dependency management and a common parent for packaging.

To test, we should have this working for the hello-world project currently in main.

PW01 - Setup module

Initialize the module for PW01 with a base picocli command class

PW01 - Base64 top command with help and usage

Start integrating picocli by setting up a top base64 command (the one called from main) with two subcommands (encode and decode).

The subcommands should be abstracted, the processing is the same.

Document monorepo usage

As mentioned in this comment, a README should be added documenting the basic steps to build and run the project and its individual modules.

depends on #1

Introduction to Java IOs

Add CI

A basic CI action should be added to build the project on every commit and run the unit tests and make sure the project compiles.

It should also upload the artifacts so that we can fetch one and compile from there.