@greg-466/package-creator
v1.1.5
Published
package creator for node.js
Maintainers
Readme
��#� �p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
�
�
�C�L�I� �t�o� �b�o�o�t�s�t�r�a�p� �a� �m�i�n�i�m�a�l� �N�o�d�e�.�j�s� �T�y�p�e�S�c�r�i�p�t� �p�a�c�k�a�g�e� �w�i�t�h� �s�e�n�s�i�b�l�e� �d�e�f�a�u�l�t�s� �a�n�d� �s�o�m�e� �a�n�i�m�a�t�e�d� �t�e�r�m�i�n�a�l� �f�e�e�d�b�a�c�k�.�
�
�
�
�I�t� �i�s� �p�u�b�l�i�s�h�e�d� �a�s� ��@�g�r�e�g�-�4�6�6�/�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�� �a�n�d� �e�x�p�o�s�e�s� �t�h�e� ��p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�� �b�i�n�a�r�y�.�
�
�
�
�#�#� �W�h�a�t� �i�t� �d�o�e�s�
�
�
�
�W�h�e�n� �y�o�u� �r�u�n� ��p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�� �i�n� �a�n� �e�x�i�s�t�i�n�g� �o�r� �n�e�w� �f�o�l�d�e�r�,� �i�t� �w�i�l�l�:�
�
�
�
�-� ���E�n�s�u�r�e� ��p�a�c�k�a�g�e�.�j�s�o�n�� �e�x�i�s�t�s��� � �
�
� � �-� �I�f� �n�o�n�e� �i�s� �f�o�u�n�d�,� �i�t� �r�u�n�s� ��n�p�m� �i�n�i�t�� �i�n�t�e�r�a�c�t�i�v�e�l�y� �t�o� �c�r�e�a�t�e� �o�n�e�.�
�
�
�
�-� ���C�r�e�a�t�e� �c�o�r�e� �p�r�o�j�e�c�t� �f�i�l�e�s� �(�i�f� �m�i�s�s�i�n�g�)���
�
� � �-� ��t�s�c�o�n�f�i�g�.�j�s�o�n�� �w�i�t�h�:�
�
� � � � �-� ��t�a�r�g�e�t��:� ��E�S�2�0�2�2��
�
� � � � �-� ��m�o�d�u�l�e��:� ��E�S�N�e�x�t��
�
� � � � �-� ��m�o�d�u�l�e�R�e�s�o�l�u�t�i�o�n��:� ��B�u�n�d�l�e�r��
�
� � � � �-� ��t�y�p�e�s��:� ��[�"�n�o�d�e�"�]��
�
� � � � �-� ��s�t�r�i�c�t��:� ��t�r�u�e��
�
� � � � �-� ��e�s�M�o�d�u�l�e�I�n�t�e�r�o�p��:� ��t�r�u�e��
�
� � �-� ��i�n�d�e�x�.�t�s�� �w�i�t�h� �a� �s�i�m�p�l�e� �s�t�a�r�t�e�r� �e�x�p�o�r�t�:�
�
� � � � ����t�s�
�
� � � � �e�x�p�o�r�t� �c�o�n�s�t� �h�e�l�l�o� �=� �(�)� �=�>� �c�o�n�s�o�l�e�.�l�o�g�(�"�H�e�l�l�o� �W�o�r�l�d�"�)�;�
�
� � � � ����
�
� � �-� ��R�E�A�D�M�E�.�m�d�� �g�e�n�e�r�a�t�e�d� �f�r�o�m� �y�o�u�r� ��p�a�c�k�a�g�e�.�j�s�o�n�� �m�e�t�a�d�a�t�a� �(�n�a�m�e�,� �d�e�s�c�r�i�p�t�i�o�n�,� �a�u�t�h�o�r�,� �l�i�c�e�n�s�e�,� �b�i�n�)�.�
�
� � �-� ��.�g�i�t�i�g�n�o�r�e�� �c�o�n�t�a�i�n�i�n�g�:�
�
� � � � ����
�
� � � � �n�o�d�e�_�m�o�d�u�l�e�s�
�
� � � � ����
�
� � �-� ��.�n�p�m�i�g�n�o�r�e�� �(�e�m�p�t�y� �b�y� �d�e�f�a�u�l�t�)�.�
�
�
�
�-� ���C�o�n�f�i�g�u�r�e� ��p�a�c�k�a�g�e�.�j�s�o�n�� �(�i�d�e�m�p�o�t�e�n�t�l�y�)���
�
� � �-� �E�n�s�u�r�e�s� ��t�y�p�e�� �i�s� �s�e�t� �t�o� ��"�m�o�d�u�l�e�"�� �(�i�f� �n�o�t� �a�l�r�e�a�d�y� �d�e�f�i�n�e�d�)�.�
�
� � �-� �E�n�s�u�r�e�s� ��m�a�i�n�� �i�s� �s�e�t� �t�o� ��"�i�n�d�e�x�.�t�s�"�� �(�i�f� �n�o�t� �a�l�r�e�a�d�y� �d�e�f�i�n�e�d�)�.�
�
� � �-� �E�n�s�u�r�e�s� ��b�i�n�� �c�o�n�t�a�i�n�s� �a� �C�L�I� �e�n�t�r�y� �p�o�i�n�t�i�n�g� �a�t� ��i�n�d�e�x�.�t�s��:�
�
� � � � �-� �I�f� ��b�i�n�� �i�s� �m�i�s�s�i�n�g� �o�r� �a� �s�t�r�i�n�g�,� �i�t� �b�e�c�o�m�e�s� �a�n� �o�b�j�e�c�t� �l�i�k�e�:�
�
� � � � � � ����j�s�o�n�
�
� � � � � � �{�
�
� � � � � � � � �"�b�i�n�"�:� �{�
�
� � � � � � � � � � �"�<�c�l�i�-�n�a�m�e�>�"�:� �"�i�n�d�e�x�.�t�s�"�
�
� � � � � � � � �}�
�
� � � � � � �}�
�
� � � � � � ����
�
� � � � �-� ��<�c�l�i�-�n�a�m�e�>�� �i�s� �i�n�f�e�r�r�e�d� �f�r�o�m� �t�h�e� �e�x�i�s�t�i�n�g� ��b�i�n�� �f�i�e�l�d�,� �o�r� �e�l�s�e� �f�r�o�m� �t�h�e� �p�a�c�k�a�g�e� �n�a�m�e�.�
�
� � �-� �A�d�d�s�/�k�e�e�p�s� �s�t�a�n�d�a�r�d� �n�p�m� �s�c�r�i�p�t�s� �w�h�e�n� �t�h�e�y� �a�r�e� �m�i�s�s�i�n�g�:�
�
� � � � �-� ��c�l�e�a�n��:� ��r�m� �-�r�f� �d�i�s�t��
�
� � � � �-� ��b�u�i�l�d��:� ��t�s�c��
�
� � � � �-� ��p�r�e�p�a�r�e��:� ��n�p�m� �r�u�n� �b�u�i�l�d��
�
� � � � �-� ��p�r�e�t�t�i�e�r��:� ��p�r�e�t�t�i�e�r� �-�-�w�r�i�t�e� �.��
�
� � � � �-� ��l�i�n�t��:� ��e�s�l�i�n�t� �.��
�
� � � � �-� ��t�e�s�t��:� ��e�c�h�o� �"�E�r�r�o�r�:� �n�o� �t�e�s�t� �s�p�e�c�i�f�i�e�d�"� �&�&� �e�x�i�t� �1��
�
� � � � �-� ��p�u�b�l�i�s�h��:� �d�e�f�a�u�l�t�s� �t�o� ��n�o�d�e� �-�-�l�o�a�d�e�r� �t�s�-�n�o�d�e�/�e�s�m� �u�t�i�l�s�/�u�t�i�l�s�.�t�s�� �i�f� �n�o�t� �s�e�t�.�
�
�
�
�-� ���S�e�t� �u�p� �v�e�r�s�i�o�n� �b�u�m�p� �a�u�t�o�m�a�t�i�o�n���
�
� � �-� �C�r�e�a�t�e�s� ��s�c�r�i�p�t�s�/�u�p�d�a�t�e�-�v�e�r�s�i�o�n�.�m�j�s�� �i�f� �m�i�s�s�i�n�g�.�
�
� � �-� �E�n�s�u�r�e�s� �a� ��p�r�e�p�u�b�l�i�s�h�O�n�l�y�� �h�o�o�k� �r�u�n�s�:�
�
� � � � ����b�a�s�h�
�
� � � � �n�o�d�e� �s�c�r�i�p�t�s�/�u�p�d�a�t�e�-�v�e�r�s�i�o�n�.�m�j�s�
�
� � � � ����
�
� � � � �(�p�r�e�p�e�n�d�e�d� �t�o� �a�n�y� �e�x�i�s�t�i�n�g� ��p�r�e�p�u�b�l�i�s�h�O�n�l�y�� �s�c�r�i�p�t�)�.�
�
� � �-� �G�u�a�r�a�n�t�e�e�s� �t�h�e�r�e� �i�s� �a� ��p�u�b�l�i�s�h�� �s�c�r�i�p�t� �(�d�e�f�a�u�l�t�s� �t�o� ��n�p�m� �p�u�b�l�i�s�h�� �i�f� �n�o�n�e�)�.�
�
�
�
�-� ���C�r�e�a�t�e� �a� ��u�t�i�l�s�� �h�e�l�p�e�r� �f�o�l�d�e�r���
�
� � �-� �E�n�s�u�r�e�s� ��u�t�i�l�s�/�� �e�x�i�s�t�s�.�
�
� � �-� �C�r�e�a�t�e�s� �a�n� �e�m�p�t�y� ��u�t�i�l�s�/�u�t�i�l�s�.�t�s�� �i�f� �i�t� �d�o�e�s� �n�o�t� �a�l�r�e�a�d�y� �e�x�i�s�t�.�
�
�
�
�-� ���S�h�o�w� �a�n�i�m�a�t�e�d� �f�e�e�d�b�a�c�k���
�
� � �-� �D�i�s�p�l�a�y�s� �a� �n�e�o�n� �A�S�C�I�I� �b�a�n�n�e�r� �w�h�e�n� �s�t�a�r�t�i�n�g�.�
�
� � �-� �S�h�o�w�s� �a� �r�a�i�n�b�o�w�/�g�l�i�t�c�h� �a�n�i�m�a�t�i�o�n� �w�h�e�n� �c�r�e�a�t�i�n�g� �o�r� �r�e�u�s�i�n�g� �f�o�l�d�e�r�s�/�f�i�l�e�s�.�
�
� � �-� �U�s�e�s� �a� �s�p�i�n�n�e�r� �a�n�i�m�a�t�i�o�n� �w�h�i�l�e� �t�h�e� �m�a�i�n� �s�e�t�u�p� �r�u�n�s�,� �t�h�e�n� �p�r�i�n�t�s�:�
�
� � � � ����
�
� � � � �N�O�D�E�J�S� �P�A�C�K�A�G�E� �S�T�A�R�T�E�R� �K�I�T� �C�R�E�A�T�E�D�
�
� � � � ����
�
�
�
�#�#� �P�r�e�r�e�q�u�i�s�i�t�e�s�
�
�
�
�-� �N�o�d�e�.�j�s� �1�8�+� �(�f�o�r� �n�a�t�i�v�e� �E�S�M� �a�n�d� ��n�o�d�e�:�� �i�m�p�o�r�t�s�)�.�
�
�-� �n�p�m� �(�c�o�m�e�s� �w�i�t�h� �N�o�d�e�)�.�
�
�-� �A�n� �i�n�t�e�r�a�c�t�i�v�e� �t�e�r�m�i�n�a�l� �(�t�h�e� �s�c�r�i�p�t� �u�s�e�s� �a�n�i�m�a�t�i�o�n�s� �a�n�d� �i�n�h�e�r�i�t�s� �s�t�d�i�n�/�s�t�d�o�u�t�)�.�
�
�
�
�#�#� �I�n�s�t�a�l�l�a�t�i�o�n�
�
�
�
�I�n�s�t�a�l�l� �l�o�c�a�l�l�y� �i�n� �a� �p�r�o�j�e�c�t�:�
�
�
�
����b�a�s�h�
�
�n�p�m� �i�n�s�t�a�l�l� �-�-�s�a�v�e�-�d�e�v� �@�g�r�e�g�-�4�6�6�/�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
����
�
�
�
�O�r� �r�u�n� �i�t� �a�d� h�o�c� �w�i�t�h� ��n�p�x�� �(�n�o� �g�l�o�b�a�l� �i�n�s�t�a�l�l� �n�e�e�d�e�d�)�:�
�
�
�
����b�a�s�h�
�
�n�p�x� �@�g�r�e�g�-�4�6�6�/�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
����
�
�
�
�Y�o�u� �c�a�n� �a�l�s�o� �i�n�s�t�a�l�l� �i�t� �g�l�o�b�a�l�l�y�:�
�
�
�
����b�a�s�h�
�
�n�p�m� �i�n�s�t�a�l�l� �-�g� �@�g�r�e�g�-�4�6�6�/�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
�
�
�#� �n�o�w� �t�h�e� �b�i�n�a�r�y� �i�s� �a�v�a�i�l�a�b�l�e� �a�s�:�
�
�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
����
�
�
�
�#�#� �U�s�a�g�e�
�
�
�
�F�r�o�m� �i�n�s�i�d�e� �t�h�e� �f�o�l�d�e�r� �w�h�e�r�e� �y�o�u� �w�a�n�t� �t�o� �(�o�r� �a�l�r�e�a�d�y�)� �h�a�v�e� �a� �N�o�d�e�.�j�s� �p�a�c�k�a�g�e�:�
�
�
�
����b�a�s�h�
�
�n�p�x� �p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�
�
����
�
�
�
�T�h�i�s� �w�i�l�l�:�
�
�
�
�-� �R�u�n� ��n�p�m� �i�n�i�t�� �i�f� �n�o� ��p�a�c�k�a�g�e�.�j�s�o�n�� �i�s� �p�r�e�s�e�n�t�.�
�
�-� �C�r�e�a�t�e� �m�i�s�s�i�n�g� �f�i�l�e�s� �(��t�s�c�o�n�f�i�g�.�j�s�o�n��,� ��i�n�d�e�x�.�t�s��,� ��R�E�A�D�M�E�.�m�d��,� ��.�g�i�t�i�g�n�o�r�e��,� ��.�n�p�m�i�g�n�o�r�e��)�.�
�
�-� �U�p�d�a�t�e� �y�o�u�r� ��p�a�c�k�a�g�e�.�j�s�o�n�� �s�c�r�i�p�t�s�/�b�i�n�/�v�e�r�s�i�o�n� �a�u�t�o�m�a�t�i�o�n� �i�n� �a� �n�o�n�-�d�e�s�t�r�u�c�t�i�v�e� �w�a�y�.�
�
�
�
�#�#�#� �C�L�I� �f�l�a�g�s�
�
�
�
�-� ��-�-�f�o�r�c�e�� � �
�
� � �O�v�e�r�w�r�i�t�e� �f�i�l�e�s� �e�v�e�n� �i�f� �t�h�e�y� �a�l�r�e�a�d�y� �e�x�i�s�t�.� �W�i�t�h�o�u�t� �t�h�i�s� �f�l�a�g�,� �e�x�i�s�t�i�n�g� �f�i�l�e�s� �a�r�e� �l�e�f�t� �a�l�o�n�e� �a�n�d� �y�o�u� l�l� �s�e�e� �m�e�s�s�a�g�e�s� �l�i�k�e�:�
�
� � ����
�
� � �S�k�i�p�p�i�n�g� �R�E�A�D�M�E�.�m�d�:� �f�i�l�e� �a�l�r�e�a�d�y� �e�x�i�s�t�s� �(�u�s�e� �-�-�f�o�r�c�e� �t�o� �o�v�e�r�w�r�i�t�e�)�.�
�
� � ����
�
�
�
�-� ��-�-�s�k�i�p�-�r�e�a�d�m�e�� � �
�
� � �D�o� ���n�o�t��� �c�r�e�a�t�e� �o�r� �o�v�e�r�w�r�i�t�e� ��R�E�A�D�M�E�.�m�d��.� �U�s�e�f�u�l� �i�f� �y�o�u� �a�l�r�e�a�d�y� �m�a�i�n�t�a�i�n� �a� �c�u�s�t�o�m� �R�E�A�D�M�E�.�
�
�
�
�Y�o�u� �c�a�n� �c�o�m�b�i�n�e� �t�h�e�m�,� �f�o�r� �e�x�a�m�p�l�e�:�
�
�
�
����b�a�s�h�
�
�n�p�x� �p�a�c�k�a�g�e�-�c�r�e�a�t�o�r� �-�-�f�o�r�c�e� �-�-�s�k�i�p�-�r�e�a�d�m�e�
�
����
�
�
�
�#�#� �H�o�w� �t�h�e� �g�e�n�e�r�a�t�e�d� �R�E�A�D�M�E� �w�o�r�k�s�
�
�
�
�I�f� ��R�E�A�D�M�E�.�m�d�� �d�o�e�s�n� t� �e�x�i�s�t� �a�n�d� �y�o�u� �h�a�v�e�n� t� �p�a�s�s�e�d� ��-�-�s�k�i�p�-�r�e�a�d�m�e��,� �t�h�e� �t�o�o�l�:�
�
�
�
�-� �R�e�a�d�s� �y�o�u�r� ��p�a�c�k�a�g�e�.�j�s�o�n��.�
�
�-� �D�e�r�i�v�e�s�:�
�
� � �-� �N�a�m�e�
�
� � �-� �V�e�r�s�i�o�n�
�
� � �-� �D�e�s�c�r�i�p�t�i�o�n�
�
� � �-� �A�u�t�h�o�r� �(�s�t�r�i�n�g� �o�r� ��{� �n�a�m�e� �}�� �f�o�r�m�)�
�
� � �-� �L�i�c�e�n�s�e�
�
� � �-� �C�L�I� �c�o�m�m�a�n�d� �n�a�m�e� �(�b�a�s�e�d� �o�n� ��b�i�n�� �o�r� �f�a�l�l�b�a�c�k� �t�o� �p�a�c�k�a�g�e� �n�a�m�e�)�
�
�-� �W�r�i�t�e�s� �a� �b�a�s�i�c� �R�E�A�D�M�E� �t�e�m�p�l�a�t�e� �w�i�t�h�:�
�
� � �-� �A�b�o�u�t� �s�e�c�t�i�o�n� �(�a�u�t�h�o�r�,� �v�e�r�s�i�o�n�,� �d�e�s�c�r�i�p�t�i�o�n�,� �l�i�c�e�n�s�e�)�.�
�
� � �-� �I�n�s�t�a�l�l� �i�n�s�t�r�u�c�t�i�o�n�s� �(��n�p�m� �i�n�s�t�a�l�l� �<�n�a�m�e�>�� �/� ��n�p�x� �<�c�l�i�>��)�.�
�
� � �-� �P�l�a�c�e�h�o�l�d�e�r� �c�o�n�f�i�g�u�r�a�t�i�o�n� �n�o�t�e�s�.�
�
�
�
�Y�o�u� �c�a�n� �e�d�i�t� �t�h�e� �g�e�n�e�r�a�t�e�d� �R�E�A�D�M�E� �a�f�t�e�r�w�a�r�d�s� �a�s� �y�o�u� �s�e�e� �f�i�t�.�
�
�
�
�#�#� �D�e�v�e�l�o�p�m�e�n�t�
�
�
�
�T�o� �w�o�r�k� �o�n� ��p�a�c�k�a�g�e�-�c�r�e�a�t�o�r�� �i�t�s�e�l�f� �i�n� �t�h�i�s� �r�e�p�o�:�
�
�
�
����b�a�s�h�
�
�n�p�m� �i�n�s�t�a�l�l�
�
�n�p�m� �r�u�n� �b�u�i�l�d�
�
����
�
�
�
�T�h�e� �C�L�I� �e�n�t�r�y� �p�o�i�n�t� �i�s� ��s�r�c�/�i�n�d�e�x�.�t�s�� �(�b�u�i�l�t� �t�o� ��d�i�s�t�/�i�n�d�e�x�.�j�s��)�,� �a�n�d� �t�h�e� �p�a�c�k�a�g�e� �i�s� �p�u�b�l�i�s�h�e�d� �u�n�d�e�r� ��@�g�r�e�g�-�4�6�6�/�p�a�c�k�a�g�e�-�c�r�e�a�t�o�r��.�
